Sign in
Businesses

List Businesses

get/v2/businesses

Query parameters

businessNamestring
businessNameOrUuidstring

Partial or full business name or UUID.

integrationUuidsstring[]

One or more integration uuids related to businesses to filter by.

statusstring[]

The status of a business. If no status is provided then it fetches all

limitnumber
offsetnumber

Response

Example response

{
  "meta": {
    "count": 1,
    "offset": 1,
    "limit": 1,
    "currentPage": 1,
    "totalPages": 1
  },
  "data": [
    {
      "businessUuid": "BIZ-0f1ef788-54eb-4ed1-a7d3-5605febe6d84",
      "businessName": "Railz",
      "status": "active",
      "createdAt": "2020-12-25T01:02:03Z",
      "updatedAt": "2020-12-25T01:02:03Z",
      "metadata": [
        {
          "name": "new business1",
          "value": "canada",
          "webhookLocation": [
            "header",
            "body"
          ]
        }
      ],
      "connections": [
        {
          "connectionUuid": "CON-e66400c1-4d2f-4683-9bea-275799943695",
          "firstRecordDate": "2020-12-25T01:02:03Z",
          "serviceName": "xero",
          "description": "TD Bank",
          "status": "active",
          "createdAt": "2020-12-25T01:02:03Z",
          "updatedAt": "2020-12-25T01:02:03Z",
          "disconnectReason": "disconnectedByCustomer",
          "institution": {
            "name": "Citizens bank",
            "logo": "https://serverlogo.url"
          },
          "isMockData": true,
          "serviceAccountRef": {
            "id": "12345",
            "entityRef": {
              "id": "100"
            }
          }
        }
      ]
    }
  ]
}