Users, Teams & Organization

Manage user profiles, organization settings, member administration, and teams. Teams control resource visibility when using team_level access.

Remove profile avatar

DELETE

/v1/entity/me/avatar

Remove the caller's avatar. The profile falls back to a generated placeholder.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"avatar_fallback_url": "string",

  

"display_name": "string",

  

"email": "string",

  

"first_name": "string",

  

"has_avatar": true,

  

"has_password": true,

  

"last_name": "string",

  

"locale": "string",

  

"user_id": "string"

}

Samples

Download current user's avatar

GET

/v1/entity/me/avatar

Stream the caller's avatar image.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

[

]

Samples

Upload profile avatar

POST

/v1/entity/me/avatar

Stores the image and updates the user's avatar reference.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

multipart/form-data

Profile photo (JPEG, PNG, WebP, or GIF; max 5 MB)

Responses

Successful Response

Content-Type

application/json

{

  

"avatar_fallback_url": "string",

  

"display_name": "string",

  

"email": "string",

  

"first_name": "string",

  

"has_avatar": true,

  

"has_password": true,

  

"last_name": "string",

  

"locale": "string",

  

"user_id": "string"

}

Samples

Current org and team membership

GET

/v1/entity/me/membership

Returns the caller's organization membership and every team in the org. Teams the caller belongs to include their team-admin status and join time; other teams are included for org-structure visibility.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"document_ingestion_mode": "string",

  

"document_ocr_model": "string",

  

"document_ocr_threshold": 0,

  

"is_org_admin": true,

  

"org_id": "string",

  

"org_name": "string",

  

"teams": [

  

  

{

  

  

  

"added_at": "string",

  

  

  

"is_team_admin": true,

  

  

  

"name": "string",

  

  

  

"team_id": "string"

  

  

}

  

],

  

"tier": "string",

  

"user_id": "string"

}

Samples

Current user profile

GET

/v1/entity/me/profile

Returns the authenticated user's email, display name, and avatar status.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"avatar_fallback_url": "string",

  

"display_name": "string",

  

"email": "string",

  

"first_name": "string",

  

"has_avatar": true,

  

"has_password": true,

  

"last_name": "string",

  

"locale": "string",

  

"user_id": "string"

}

Samples

Update current user profile

PATCH

/v1/entity/me/profile

Update the caller's own profile. Only the fields present in the request body
are changed.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

Any of

Any of

Any of

Any of

Responses

Successful Response

Content-Type

application/json

{

  

"avatar_fallback_url": "string",

  

"display_name": "string",

  

"email": "string",

  

"first_name": "string",

  

"has_avatar": true,

  

"has_password": true,

  

"last_name": "string",

  

"locale": "string",

  

"user_id": "string"

}

Samples

List organization members

GET

/v1/entity/members

List the members of the caller's organization.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"added_at": "string",

  

  

  

"added_by": "string",

  

  

  

"disabled": true,

  

  

  

"display_name": "string",

  

  

  

"email": "string",

  

  

  

"first_name": "string",

  

  

  

"is_admin": true,

  

  

  

"last_name": "string",

  

  

  

"teams": [

  

  

  

  

{

  

  

  

  

  

"is_team_admin": true,

  

  

  

  

  

"team_id": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"user_id": "string"

  

  

}

  

],

  

"member_limit": 0,

  

"org_id": "string",

  

"tier": "string"

}

Samples

Create organization member

POST

/v1/entity/members

Add a user to the caller's organization. A new email creates the account; the email
of an existing account that belongs to no organization attaches that account and
ignores password and display_name. Optionally assign the user to a team in
the same request. Requires organization admin, or team admin of team_id when
is_admin is false.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

Any of

Format"email"

Defaultfalse

Defaultfalse

Any of

Format"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"display_name": "string",

  

"email": "string",

  

"is_org_admin": true,

  

"is_team_admin": false,

  

"org_id": "string",

  

"team_id": "string",

  

"tier": "string",

  

"user_id": "string"

}

Samples

Remove organization member

DELETE

/v1/entity/members/{user_id}

Remove a member from the caller's organization and its teams and end their sessions.
Their account is kept: adding the same email again restores access to their
content. Requires organization admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Samples

Update organization member

PATCH

/v1/entity/members/{user_id}

Update a member's email, display name, or organization-admin status. Only the
fields present in the request body are changed. Email and display name require
organization admin or team admin of a team the member belongs to;
is_org_admin requires organization admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

Any of

Any of

Format"email"

Any of

Responses

Successful Response

Content-Type

application/json

{

  

"added_at": "string",

  

"added_by": "string",

  

"disabled": true,

  

"display_name": "string",

  

"email": "string",

  

"first_name": "string",

  

"is_admin": true,

  

"last_name": "string",

  

"teams": [

  

  

{

  

  

  

"is_team_admin": true,

  

  

  

"team_id": "string"

  

  

}

  

],

  

"user_id": "string"

}

Samples

Download a user's avatar

GET

/v1/entity/members/{user_id}/avatar

Stream another organization member's avatar image.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

[

]

Samples

Disable user account

POST

/v1/entity/members/{user_id}/disable

Disable a member's account. They can no longer sign in; their resources are
retained. Requires organization admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Samples

Re-enable user account

POST

/v1/entity/members/{user_id}/enable

Re-enable a previously disabled member's account. Requires organization admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Samples

Reset user password

POST

/v1/entity/members/{user_id}/reset-password

Reset a managed user's password on their behalf. Requires organization admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

Responses

Successful Response

Samples

Delete organization

DELETE

/v1/entity/org

Permanently delete the caller's organization. Soft-deletes all member accounts, removes org resources, and invalidates sessions.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Samples

Rename organization

PATCH

/v1/entity/org

Rename the caller's organization. Also updates the org-root folder name.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

Samples

Update organization settings

PATCH

/v1/entity/org/settings

Org admins only. Applies to documents ingested after the change.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

How new PDFs are read. ocr: local OCR only. hybrid (default): images the OCR is unsure of are re-read by a model. llm: every image is re-read by a model.

Valid values"ocr""hybrid""llm"

Responses

Successful Response

Content-Type

application/json

{

  

"document_ingestion_mode": "string"

}

Samples

List organization teams

GET

/v1/entity/teams

List the teams in the caller's organization.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"created_at": "string",

  

  

  

"id": "string",

  

  

  

"name": "string",

  

  

  

"org_id": "string"

  

  

}

  

],

  

"org_id": "string",

  

"tier": "string"

}

Samples

Create organization team

POST

/v1/entity/teams

Create a team in the caller's organization. Requires organization admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

Responses

Successful Response

Content-Type

application/json

{

  

"created_at": "string",

  

"id": "string",

  

"name": "string",

  

"org_id": "string"

}

Samples

Disable organization team

DELETE

/v1/entity/teams/{team_id}

Disable a team in the caller's organization. Members remain in the org but must sign in again; the team is hidden from rosters.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

team_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Samples

List team members

GET

/v1/entity/teams/{team_id}/members

List the members of a team.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

team_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"added_at": "string",

  

  

  

"added_by": "string",

  

  

  

"disabled": true,

  

  

  

"display_name": "string",

  

  

  

"email": "string",

  

  

  

"is_team_admin": true,

  

  

  

"user_id": "string"

  

  

}

  

],

  

"team_id": "string",

  

"tier": "string"

}

Samples

Remove user from team

DELETE

/v1/entity/teams/{team_id}/members/{user_id}

Remove a member from the team. The user keeps their org membership and account.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

team_id*

Type

string

Required

Format

"uuid"

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Samples

Update team member

PATCH

/v1/entity/teams/{team_id}/members/{user_id}

Promote or demote a member as team admin.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

team_id*

Type

string

Required

Format

"uuid"

user_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

True grants the member team-admin rights; false revokes them.

Responses

Successful Response

Content-Type

application/json

{

  

"added_at": "string",

  

"added_by": "string",

  

"is_admin": true,

  

"team_id": "string",

  

"user_id": "string"

}

Samples

Add existing org member to team

PUT

/v1/entity/teams/{team_id}/members/{user_id}

Add an existing organization member to a team. Idempotent: an existing
membership is returned unchanged; use PATCH to change the team-admin role.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

team_id*

Type

string

Required

Format

"uuid"

user_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

Any of

True adds the member with team-admin rights.

Defaultfalse

Responses

Successful Response

Content-Type

application/json

{

  

"added_at": "string",

  

"added_by": "string",

  

"is_admin": true,

  

"team_id": "string",

  

"user_id": "string"

}

Samples