Company Users API

Create, update, import, deactivate, and list users in your company.

MethodEndpointDescription
GET/v1/company/usersList users.
POST/v1/company/usersCreate a user.
GET/v1/company/users/{id}Get one user.
PUT/v1/company/users/{id}Update a user.
DELETE/v1/company/users/{id}Delete or deactivate a user.
POST/v1/company/users/importImport multiple users.

User Fields

FieldTypeDescription
namestringFull user name.
emailstringUnique company email address.
departmentstringDepartment name.
job_titlestringJob title.
localestringPreferred language.
statusstringactive, invited, or inactive.

Response Example

{
  "data": {
    "id": 42,
    "name": "Jane Doe",
    "email": "jane{'@'}example.com",
    "department": "Finance",
    "status": "active"
  }
}