List projects

GET

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

GET

/v3/projects

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

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "a3f47c9e-8b2d-4f1a-9c3e-2d5f7b6a1e4c",
6         "name": "New Website Launch",
7         "fullName": "Globex Corp:New Website Launch",
8         "externalId": "NW-2024-001",
9         "customerId": "b7d9f8e2-3c4a-4d5b-9f6e-7a8c9d0e1f2b"
10       },
11       {
12         "id": "d9e8f7a6-b5c4-3d2e-1f0a-9b8c7d6e5f4a",
13         "name": "Internal Audit",
14         "fullName": "Internal:Internal Audit",
15         "externalId": "IA-2024-002",
16         "customerId": null
17       }
18     ]
19   },
20   "success": true,
21   "message": "Projects retrieved successfully",
22   "error": {
23     "code": 0,
24     "message": "",
25     "details": {}
26   }
27 }

Projects synced from the connected ERP (e.g. Sage Intacct). Can be populated on an obligation or billing term. A project may be tied to a single customer via customerId, or null for internal projects.

Authentication

Authorizationstring

API Key authentication via header

Response

Get projects

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