REST API Documentation

NOTE: The API requires at least xltrail v2.1.0

API Token

Go to Settings > Organization > Personal API Token to copy your token.

Headers

All requests must include the following headers:

Authorization: <API Token>
Accept: application/json
Content-Type: application/json

Base URL

The base URL is the URL of your xltrail app + /api/v1. If you are using the cloud, it would be https://app.xltrail.com/api/v1. Always prepend the base URL in front of the endpoints below.

Endpoints

GET /workbooks

Lists the available workbooks across all projects with their meta information.

Query Parameters

Parameter Description
status [optional] Status filter. Available values are: processing or failure.
q [optional] Query string. Allows to filter workbooks by name.

Sample Request

curl --request GET \
  --header "Authorization: your_api_token" \
  --header "Accept: application/json" \
  --header "Content-type: application/json" \
  "https://app.xltrail.com/api/v1/workbooks?status=processing"

Sample Response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "type": "workbook",
      "id": "github.com/xlwings/xlwings.git/examples/fibonacci/fibonacci.xlsm",
      "name": "/examples/fibonacci/fibonacci.xlsm",
      "display_name": "fibonacci.xlsm",
      "integration": "github.com/xlwings/xlwings.git",
      "created_at": "2014-03-19T13:15:45+00:00",
      "version": {
        "id": "75dacc45c5f1ce9557be1bdd3aac7f27a6f562c7",
        "branch": "master",
        "author": "Felix Zumstein",
        "action": "modify",
        "created_at": "2017-07-02T09:44:04+00:00",
        "message": "add addin ref to examples, remove template\n",
        "status": "success",
        "url": "/raw/1a2e2d114b766c3687d69dca2b86b165c28eb39ebcae2acefa998f642c7fb251/fibonacci_75dacc4.xlsm",
        "parent": {
          "id": "071083655768295bd4d1e82048ae92f3518bd22f"
        }
      },
      "content": {
        "vba": 1,
        "sheets": 2
      },
      "file": {
        "size": 20431,
        "type": "xlsm",
        "digest": "1a2e2d114b766c3687d69dca2b86b165c28eb39ebcae2acefa998f642c7fb251",
        "created_at": "2017-07-02T09:44:04+00:00"
      },
      "status": {
        "processing": 28,
        "failure": 0
      }
    }
  ]
}

results matching ""

    No results matching ""