Skip to main content
GET
List all organisations

Authorizations

Authorization
string
header
required

Access token obtained from /oauth/token. Pass as Authorization: Bearer {token}

Query Parameters

organisation_id
string

Returns a specific organisation under your head office by its organisation ID.

Response

A list of organisations

id
string

The unique identifier for the organisation

Example:

"2089_9531"

address
object
departments
object[]

A list of departments within this organisation

name
string

The display name of the organisation

Example:

"Acme Supermarket"

roles
object[]

A list of all roles available across this organisation

shifts
object[]

A list of shift templates defined for this organisation

workDayFinishTime
string

The default work day finish time for the organisation in HH:MM format

Example:

"22:00"

workDayStartTime
string

The default work day start time for the organisation in HH:MM format

Example:

"06:00"