Members

All endpoints require a valid JWT Bearer token in the Authorization header.

List company members

Returns a paginated list of all users who belong to a specific company. Supports filtering by role, name, and email.

GET /company/{company_id}/users

Path parameters

company_id

integer

required

The ID of the company whose members you want to retrieve.

Query parameters

page

integer

default:"1"

Page number to retrieve. Must be 1 or greater.

limit

integer

default:"10"

Number of records per page. Accepted range: 1–100.

role_name

string

Filter results to members with this role name.

first_name

string

Filter results by user first name.

last_name

string

Filter results by user last name.

string

Filter results by user email address.

Response fields

message

string

Human-readable confirmation message.

data

object

Paginated response wrapper.

Show data properties

records

object[]

Array of company member objects.

Show record properties

integer

Unique identifier for the user.

string

User email address.

first_name

string

User’s first name.

last_name

string

User’s last name.

phone_number

string

User’s phone number.

status

string

Account status. Possible values: "Awaiting Verification: User must verify their email", "Active: Verified and allowed to log in", "Suspended: Temporarily disabled by admin", "Deactivated: User closed or deleted account", "Banned: Permanently removed for violating terms".

is_superuser

boolean

Whether the user has global superuser privileges.

role_name

string

The role this user holds within the company.

pagination

object

Pagination metadata.

Show pagination properties

total_records

integer

Total number of matching records.

limit

integer

Number of records per page.

current_page

integer

The current page number.

total_pages

integer

Total number of available pages.

Error codes

Status	Description
`400`	The request contains invalid query parameters.
`404`	No company found with the given `company_id`.
`500`	An unexpected server error occurred.

Example

curl --request GET \
  --url 'https://api.example.com/company/42/users?page=1&limit=20&role_name=Viewer' \
  --header 'Authorization: Bearer <token>'

Add a member

Adds an existing user to a company and assigns them a role.

POST /company/{company_id}/users

Path parameters

company_id

integer

required

The ID of the company to add the user to.

Request body

string

required

Email address of the user to add. Example: "user.one@email.com".

role

string

default:"Viewer"

Name of the role to assign to the user within the company. Defaults to "Viewer" if not specified.

Response fields

message

string

Human-readable confirmation message.

data

object

The updated company record.

Show data properties

integer

Unique identifier for the company.

string

Company email address.

name

string

Company display name.

description

string

Company description.

industry

string

Company industry.

phone_number

string

Company phone number.

address

object

Company address object containing street, city, state, postal_code, and country.

Error codes

Status	Description
`400`	The user is already a member of this company, or the request body is invalid.
`500`	An unexpected server error occurred.

Example

curl --request POST \
  --url https://api.example.com/company/42/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user.one@email.com",
    "role": "Administrator"
  }'

Remove a member

Removes a user from a company. The user’s account is not deleted.

DELETE /company/{company_id}/user/{user_id}

This action cannot be undone. The user will lose all access to the company immediately. Superadmin users cannot be removed.

Path parameters

company_id

integer

required

The ID of the company to remove the user from.

user_id

integer

required

The ID of the user to remove.

Response fields

message

string

Human-readable confirmation message.

data

object

The removed user’s membership record.

Show data properties

integer

Unique identifier for the user.

string

User email address.

first_name

string

User’s first name.

last_name

string

User’s last name.

phone_number

string

User’s phone number.

status

string

is_superuser

boolean

Whether the user has global superuser privileges.

role_name

string

The role the user held within the company prior to removal.

Error codes

Status	Description
`400`	The user is not a member of this company, or the user is a superadmin.
`500`	An unexpected server error occurred.

Example

curl --request DELETE \
  --url https://api.example.com/company/42/user/7 \
  --header 'Authorization: Bearer <token>'

User Endpoints

Company Endpoints

List company members

Path parameters

Query parameters

Response fields

Error codes

Example

Add a member

Path parameters

Request body

Response fields

Error codes

Example

Remove a member

Path parameters

Response fields

Error codes

Example

Build docs developers (and LLMs) love

User Endpoints

Company Endpoints

Documentation Index

​List company members

​Path parameters

​Query parameters

​Response fields

​Error codes

​Example

​Add a member

​Path parameters

​Request body

​Response fields

​Error codes

​Example

​Remove a member

​Path parameters

​Response fields

​Error codes

​Example

Build docs developers (and LLMs) love

List company members

Path parameters

Query parameters

Response fields

Error codes

Example

Add a member

Path parameters

Request body

Response fields

Error codes

Example

Remove a member

Path parameters

Response fields

Error codes

Example