Organisation

Organisation Object

Field	Type	Description
id	snowflake	the organisation's id
name	string	the organisation's name (2 - 100 characters)
description	string	a description of the organisation
owner?	boolean	whether or not the logged in user is the owner of the organisation
roles	an array of role objects	roles in the organisation

Organisation Member Object

Field	Type	Description
user	role object	the user that is a member of the organisation
roles	an array of snowflakes	array of role ids the user has within the organisation
joined_at	ISO8601 timestamp	when the user joined the organisation

{
    "user": {},
    "roles: []
}

Create Organisation

POST /organisations

Parameters

Field	Type	Description
name	string	the organisation's name (2 - 100 characters)

Get Organisation

GET /organisations/{organisation.id}

Returns the organisation object for the given organisation id.

Get Organisation Member

GET /organisations/{organisation.id}/members/{user.id}

Returns the organisation member object for the specified user.

List Organisation Members

GET /organisations/{organisation.id}/members

Returns a list of organisation member objects that are members of the organisation.

Query filters

Field	Type	Description	default
filter	string	starts with filter for a members first name, last name, or email	null

List Organisation Roles

GET /organisations/{organisation.id}/roles

Create Organisation Role

POST /organisations/{organisation.id}/roles

Change Organisation Role Order

PATCH /organisations/{organisation.id}/roles

List Organisation Workgroups

GET /organisations/{organisation.id}/workgroups

Create Organisation Workgroup

POST /organisations/{organisation.id}/workgroups

Get Organisation Documents

GET /organisations/{organisation.id}/documents

Returns a list of document objects that are members of the organisation.

Get Organisation Work Items

GET /organisations/{organisation.id}/workitems

Returns a list of work item objects that are members of the organisation.

Parameters

Field	Type	Description