Skip to main content
GET
Get users in an organisation

Authorizations

Authorization
string
header
required

Your API key prefixed by 'Token '

Path Parameters

organisationId
string
required

The ID of the organisation

Required string length: 5 - 10
Example:

"jjl8y"

Query Parameters

q
string

The search query to filter by. Partially matched against username and email address.

Example:

"docs@example.com"

limit
integer
Required range: x >= 1
page
integer
Required range: x >= 1

Response

200 response

users
object[]
required
meta
object