Skip to main content
GET
/
organisations
/
{organisation_id}
/
teams
List all teams for an organisation
curl --request GET \
  --url http://localhost:3001/portal-api/organisations/{organisation_id}/teams \
  --header 'Authorization: <api-key>'
[
  {
    "Default": true,
    "ID": 1,
    "Name": "Default Organisation All users"
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisation_id
integer
required

UID of an organisation

Example:

2

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
Default
boolean

Identifies if this team is a default team for this organisation. All new users are created in the default team unless otherwise specified.

Example:

true

​
ID
integer

UID of this team

Example:

1

​
Name
string

Name of this team

Example:

"Default Organisation All users"