Skip to main content

Workspaces API

Version: 1.0

List users

GET
/workspace/admin/orgs/{org_id}/workspaces/{workspace_id}/users

List all users and their roles within a workspace. Admin endpoints allow organization admin users to access any workspace, regardless of their role or lack thereof within the workspace.

Request

Path parameters
workspace_iduuid
Required
org_iduuid
Required
Query parameters

Filter to see the role of a specific user ID.

Responses

200

Successful Response

linksLinks
emailstring | null
full_namestring | null
role"owner" | "editor" | "viewer"
user_iduuid
{
"links": {},
"results": [
{
"email": "string",
"full_name": "string",
"role": "owner",
"user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}

401

No permission -- see authorization schemes

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

403

Request forbidden -- authorization will not help

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

404

Resource not found or user lacks access

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

405

Specified method is invalid for this resource

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

410

Resource is gone

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}

422

Unprocessable Content

detailstring | null
invalid-paramsarray | null
statusinteger
titlestring
typestring
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}