GET
/
v1
/
organizations
/
{organizationId}
/
users

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

organizationId
string
required

A unique idenifier.

Query Parameters

offset
integer
required

The offset query parameter.

limit
integer
required

The limit query parameter.

sortOrder
enum<string>

sort directions of the retrieved records. Default value desc.

Available options:
asc,
desc
sortBy
enum<string>

sort field of the retrieved records. Default value updatedAt.

Available options:
updatedAt,
username,
firstName,
lastName,
email,
role,
status
username
string

-Optional. To search by username.

search
string

-Optional. Search string. The search will be done over username, email, firstName or lastName.

Response

200 - application/json
query
object

it contains data about pagination

data
object[]

list of contracts to be retrieved

Was this page helpful?

Organization UsersDelete organization user