List organisation

A user on Hipsy (an account to login with) can have access to one or more organisations. With this API you can list all organisations that are assigned to the user. The user of the provided 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"
    },
    ...
}