List organisations

With this API you can list all organisations of which the user has access to. The user of the selected API Key will be used

Request

Make a GET request to the following endpoint with the API Key. No parameters are required.

https://api.hipsy.nl/v1/organisations/index

Response

An array will be returned with all available organisations.

Key Description
id The ID of the organisation
name The name of the organisation
slug The URL slug of the organisation. This slug is needed as parameter for organisation specific endpoints.

Example

{
  "data": [
    {
      "id": 1000,
      "name": "My organisation",
      "slug": "my-organisation",
      "logo": "https:\/\/cdn.hipsy.nl\/images\/organisations\/1000ItXCGss6.png"
    },
    ...
}