Skip to content

Users

List users
GET/organization/users
Retrieve user
GET/organization/users/{user_id}
Modify user
POST/organization/users/{user_id}
Delete user
DELETE/organization/users/{user_id}
ModelsExpand Collapse
User = object { id, added_at, email, 3 more }

Represents an individual user within an organization.

id: string

The identifier, which can be referenced in API endpoints

added_at: number

The Unix timestamp (in seconds) of when the user was added.

email: string

The email address of the user

name: string

The name of the user

object: "organization.user"

The object type, which is always organization.user

role: "owner" or "reader"

owner or reader

Accepts one of the following:
"owner"
"reader"

UsersRoles

List user organization role assignments
GET/organization/users/{user_id}/roles
Assign organization role to user
POST/organization/users/{user_id}/roles
Unassign organization role from user
DELETE/organization/users/{user_id}/roles/{role_id}