REST API Documentation
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 . |
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/git-merge-excel-files.git/contact_list.xlsm",
"name": "/contact_list.xlsm",
"display_name": "contact_list.xlsm",
"integration": "github.com/xlwings/git-merge-excel-files.git",
"version": {
"id": "84f2478d928f4381bb054a6ab02b0c322c1da1e0",
"author": "Felix Zumstein",
"action": "modify",
"created_at": "2019-08-06T15:18:51+00:00",
"message": "added stale contacts and updated contacts\n",
"status": "success",
"branch": "master",
"parent": {
"id": "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
}
},
"status": {
"processing": 0,
"failure": 0
}
}
]
}