Skip to content

reference:organisations

Axel Boberg edited this page May 24, 2019 · 2 revisions

GET /api/v1/orgs

Get a list of all organisations

Query parameters

Name Required  Value
limit  No A number limiting the number of returned results. Must be less than 200. Defaults to 25.
offset  No A number offsetting the returned results. Defaults to 0.

POST /api/v1/orgs

Create one or multiple new organisations

Headers

Name Required  Value
Content-Type  Yes application/json

Body

The body can be either a single object or an array of objects of the following format:

[
 {
  "name": "My Organisation", // A string, max 50 characters long
 }
]

GET /api/v1/orgs/:id

Get a specific organisation

GET /api/v1/orgs/:id/users

Get a list of all users in an organisation

Query parameters

Name Required  Value
limit  No A number limiting the number of returned results. Must be less than 200. Defaults to 25.
offset  No A number offsetting the returned results. Defaults to 0.