Skip to content

List org members

GET
/organization/members

List members of the organization.

Authorizations

Responses

200

A collection of user org members

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema
object
count
required

Number of items returned in the result.

integer
Example:
1
members
required
Array
object
id
string
format: uuid
email
string
format: email
createdAt
string
format: date-time
firstName
string
>= 1 characters
<= 100 characters
/\S+/
lastName
string
>= 1 characters
<= 100 characters
/\S+/
role
required

Role of organization member

string
Allowed values:
OrgAdmin
OrgOwner
Example
Content type: application/json
{
"count": 1,
"members":
}
]
}

400

Invalid input

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "string",
"message": "string"
}

401

Access token is missing or invalid

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "invalid_token",
"message": "The access token expired."
}

403

Permission denied

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "string",
"message": "string"
}

500

Internal Server Error

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

Generic API error

object
code

Unique (system-wide) error code for an error happened

string
message
required

Developer-friendly message explaining error

string
key
additional properties
any
Example
Content type: application/json
{
"code": "string",
"message": "string"
}
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?