Get ARR report

GET

https://integrators.prod.api.tabsplatform.com/v3/reports/arr

GET

/v3/reports/arr

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

200Retrieved

1 {
2   "payload": {
3     "data": [
4       {
5         "customer": {
6           "id": "482ff1f3-7270-4a62-8f78-9006f6eb2354",
7           "name": "Acme Corporation",
8           "externalIds": [
9             {
10               "id": "QB-987654321",
11               "type": "QUICKBOOKS",
12               "sourceType": "QUICKBOOKS"
13             }
14           ]
15         },
16         "timeframe": "2024-05",
17         "currency": "USD",
18         "total": 145000
19       }
20     ],
21     "limit": 50,
22     "totalItems": 1,
23     "currentPage": 1
24   },
25   "success": true,
26   "message": "ARR report retrieved successfully",
27   "error": {
28     "code": 0,
29     "message": "",
30     "details": {}
31   }
32 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleOptionalDefaults to 1

Page Number

limitdoubleOptionalDefaults to 50

Max items per page. Defaults to 50. Values above 500 will be rejected.

filterstringOptional

Format: field:rule:value — comma-separated for multiple filters.

Fields: startMonth (string): eq, gte, lte endMonth (string): eq, gte, lte customerId (uuid): eq, gte, lte currency (string): eq, gte, lte

Example: filter=startMonth:eq:value

Format: startMonth/endMonth must be YYYY-MM (e.g. 2026-01); currency must be a valid ISO 4217 code (e.g. USD, EUR).

Format: field:rule:value — comma-separated for multiple filters. Fields: startMonth (string): eq, gte, lte endMonth (string): eq, gte, lte customerId (uuid): eq, gte, lte currency (string): eq, gte, lte Example: filter=startMonth:eq:value Format: `startMonth`/`endMonth` must be `YYYY-MM` (e.g. `2026-01`); `currency` must be a valid ISO 4217 code (e.g. `USD`, `EUR`).

Response

Get ARR by filter

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