Skip to main content
GET
Retrieve a user

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Path Parameters

user_id
string
required

Unique identifier for an user.

Pattern: ^usr_[0-9a-f]{32}$
Example:

"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

A member of this workspace.

created_at
string<date-time>
required

When this user joined the workspace.

email
string
required
id
string
required

Unique identifier for an user.

Pattern: ^usr_[0-9a-f]{32}$
Example:

"usr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

name
string
required

Display name. Falls back to the email when none is set.

role
enum<string>
required

admin manages the whole account, including every workspace in it; member has the permissions granted to them in this workspace.

Available options:
admin,
member
status
enum<string>
required

inactive users cannot sign in. They stay listed because records may still be owned by them.

Available options:
active,
inactive
object
string
default:user
Allowed value: "user"