List organisations - Hipsy Docs

A user on Hipsy (an account to log in with) can have access to one or more organisations. With this API you can list all organisations that are assigned to the user of the provided API key or access token. With OAuth, this lists all organisations of the user, also those they didn't grant your app access to.

Request

Make a GET request to the following endpoint with an API key or OAuth access token. No parameters are required.

OAuth scope: organisations:read.

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

Response

An array will be returned with all available organisations. This endpoint is not paginated.

Key	Description
id	The ID of the organisation
name	The name of the organisation
slug	The URL slug of the organisation. You can use the slug or the ID in the URL of the organisation specific endpoints.
logo	URL of the logo of the organisation

Example

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