List departments

GET

https://integrators.prod.api.tabsplatform.com/v3/departments

GET

/v3/departments

$ curl https://integrators.prod.api.tabsplatform.com/v3/departments \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "a3f1c9d2-4b7e-4f8a-9c2d-5e7b3f1a9d8c",
6         "name": "Finance",
7         "fullName": "Corporate:Finance",
8         "externalId": "FIN-001"
9       },
10       {
11         "id": "b7d2e3f4-9a1c-4d5e-8f7b-2c3a4e6d7f8b",
12         "name": "Human Resources",
13         "fullName": "Corporate:Human Resources",
14         "externalId": "HR-002"
15       },
16       {
17         "id": "c9e4f5a6-7b8c-4d9e-8f1a-3b2c4d5e6f7a",
18         "name": "Sales",
19         "fullName": "Operations:Sales",
20         "externalId": "SAL-003"
21       }
22     ]
23   },
24   "success": true,
25   "message": "Departments retrieved successfully",
26   "error": {
27     "code": 0,
28     "message": "",
29     "details": {}
30   }
31 }

Departments synced from the connected ERP (QuickBooks, NetSuite, or Sage Intacct). Can be populated on an obligation or billing term.

Authentication

Authorizationstring

API Key authentication via header

Response

Get departments

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings