Skip to main content
GET
/
v1
/
organisations
List organisations
curl --request GET \
  --url https://api.halth.com/v1/organisations
{
  "items": [
    {
      "id": "org_31XEcUshz1ymodA14HALnyP48g1",
      "name": "Acme Healthcare",
      "slug": "acme-healthcare",
      "createdAt": "2023-01-15T10:30:00Z",
      "bookingsEnabled": true,
      "brandImageUrl": "https://example.com/brand-image.png",
      "wordmarkImageUrl": "https://example.com/wordmark-image.png",
      "websiteUrl": "https://example.com"
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

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

memberId
string

Filter organisations by member ID

Response

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

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10