Skip to main content
GET
/
v1
/
businesses
List businesses
curl --request GET \
  --url https://api.halth.com/v1/businesses \
  --header 'x-halth-organisation-id: <x-halth-organisation-id>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "settings": {
        "autoReconciliationEnabled": true
      },
      "taxIdentifier": "<string>",
      "countryCode": "<string>",
      "structure": "public_corporation",
      "merchantId": "<string>",
      "capabilities": [
        {
          "id": "bookings_client_management",
          "status": "inactive"
        }
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Headers

x-halth-organisation-id
string
required

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

expand
enum<string>[]
Available options:
capabilities

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10