API reference

Access details

Company user access.

Find access

GET

List users with access to the company.

Query parameters:

Name	Type	Required	Description
`search`	string	No	Partial match on email or name.
`role_id`	string	No	Filter by role ID.
`is_active`	boolean	No	Filter by active status.
`is_owner`	boolean	No	If true, returns only owners.
`is_system`	boolean	No	Filter by system-role assignment.
`id`	string	No	Filter by access record ID.
`ids`	array	No	Filter by multiple access record IDs.
`account_id`	string	No	Filter by account ID.
`email`	string	No	Filter by exact account email.
`created_at_start`	string	No	Created on or after this timestamp.
`created_at_end`	string	No	Created on or before this timestamp.
`page`	integer	No	Page number.
`limit`	integer	No	Number of results per page.

200List of access records.application/json

metaobjectoptional

Pagination metadata for list responses.

Show properties

current_pageintegeroptional

next_pageintegeroptional

Present only when more pages exist.

prev_pageintegeroptional

Present only when current_page > 1.

resultobject[]optional

Show properties

idstringoptional

Access record ID.

is_activebooleanoptional

Whether the access record is active.

is_transferredbooleanoptional

True only if access was transferred.

sso_account_idstringoptional

SSO account identifier (SSO access only).

sso_providerobjectoptional

SSO provider (SSO access only).

created_atstringoptional

roleobjectoptional

A company role.

Show properties

idintegeroptional

codestringoptional

namestringoptional

descriptionstringoptional

Present only when set.

api_permissionsstring[]optional

ui_permissionsstring[]optional

is_activebooleanoptional

property_idsstring[]optional

Property IDs the role is restricted to.

is_systembooleanoptional

True for built-in system roles (read-only).

custom_typestringenumoptional

Entity type (custom roles only).

Possible values: USER API_KEY

company_idstringoptional

Owning company (custom roles only).

access_countintegeroptional

Users/keys assigned to this role.

created_atstringoptional

Present for custom roles only.

accountobjectoptional

User account details (when expanded).

Show properties

idstringoptional

emailstringoptional

first_namestringoptional

last_namestringoptional

avatar_urlstringoptional

is_confirmedbooleanoptional

is_ssobooleanoptional

created_byobjectoptional

Account that created this record.

Show properties

idstringoptional

emailstringoptional

first_namestringoptional

last_namestringoptional

avatar_urlstringoptional

get/admin/company/access

GET /api/admin/company/access HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200List of access records.

{
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": 1
  },
  "result": [{
    "id": "string",
    "is_active": false,
    "is_transferred": false,
    "sso_account_id": "string",
    "sso_provider": {},
    "created_at": "string",
    "role": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "api_permissions": [{}],
      "ui_permissions": [{}],
      "is_active": false,
      "property_ids": [{}],
      "is_system": false,
      "custom_type": "USER",
      "company_id": "string",
      "access_count": 0,
      "created_at": "string"
    },
    "account": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string",
      "is_confirmed": false,
      "is_sso": false
    },
    "created_by": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }]
}

Create access

POST

Grant a user access to the company.

Request bodyapplication/json

target_emailstringoptional

User email. Required if `target_account_id` absent.

target_account_idstringoptional

Existing account ID. Required if `target_email` absent.

target_first_namestringnullableoptional

First name for new users.

target_last_namestringnullableoptional

Last name for new users.

role_idstringoptional

Role ID. Required if `role` absent.

rolestringoptional

Role code (e.g. `ADMIN`). Required if `role_id` absent.

property_idsstring[]optional

Restrict access to these property IDs.

is_activebooleanoptional

Whether the access record is active.

200Created access record.application/json

resultobjectoptional

A user's company access.

Show properties

idstringoptional

Access record ID.

is_activebooleanoptional

Whether the access record is active.

is_transferredbooleanoptional

True only if access was transferred.

sso_account_idstringoptional

SSO account identifier (SSO access only).

sso_providerobjectoptional

SSO provider (SSO access only).

created_atstringoptional

roleobjectoptional

A company role.

Show properties

idintegeroptional

codestringoptional

namestringoptional

descriptionstringoptional

Present only when set.

api_permissionsstring[]optional

ui_permissionsstring[]optional

is_activebooleanoptional

property_idsstring[]optional

Property IDs the role is restricted to.

is_systembooleanoptional

True for built-in system roles (read-only).

custom_typestringenumoptional

Entity type (custom roles only).

Possible values: USER API_KEY

company_idstringoptional

Owning company (custom roles only).

access_countintegeroptional

Users/keys assigned to this role.

created_atstringoptional

Present for custom roles only.

accountobjectoptional

User account details (when expanded).

Show properties

idstringoptional

emailstringoptional

first_namestringoptional

last_namestringoptional

avatar_urlstringoptional

is_confirmedbooleanoptional

is_ssobooleanoptional

created_byobjectoptional

Account that created this record.

Show properties

idstringoptional

emailstringoptional

first_namestringoptional

last_namestringoptional

avatar_urlstringoptional

post/admin/company/access

POST /api/admin/company/access HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "target_email": "string",
  "target_account_id": "string",
  "target_first_name": "string",
  "target_last_name": "string",
  "role_id": "string",
  "role": "string",
  "property_ids": [
    "string"
  ],
  "is_active": false
}

200Created access record.

{
  "result": {
    "id": "string",
    "is_active": false,
    "is_transferred": false,
    "sso_account_id": "string",
    "sso_provider": {},
    "created_at": "string",
    "role": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "api_permissions": ["string"],
      "ui_permissions": ["string"],
      "is_active": false,
      "property_ids": ["string"],
      "is_system": false,
      "custom_type": "USER",
      "company_id": "string",
      "access_count": 0,
      "created_at": "string"
    },
    "account": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string",
      "is_confirmed": false,
      "is_sso": false
    },
    "created_by": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }
}

Read access

GET

Get an access record by ID.

Path parameters:

Name	Type	Required	Description
`id`	string	Yes	Access record ID.

200The access record.application/json

resultobjectoptional

A user's company access.

Show properties

idstringoptional

Access record ID.

is_activebooleanoptional

Whether the access record is active.

is_transferredbooleanoptional

True only if access was transferred.

sso_account_idstringoptional

SSO account identifier (SSO access only).

sso_providerobjectoptional

SSO provider (SSO access only).

created_atstringoptional

roleobjectoptional

A company role.

Show properties

idintegeroptional

codestringoptional

namestringoptional

descriptionstringoptional

Present only when set.

api_permissionsstring[]optional

ui_permissionsstring[]optional

is_activebooleanoptional

property_idsstring[]optional

Property IDs the role is restricted to.

is_systembooleanoptional

True for built-in system roles (read-only).

custom_typestringenumoptional

Entity type (custom roles only).

Possible values: USER API_KEY

company_idstringoptional

Owning company (custom roles only).

access_countintegeroptional

Users/keys assigned to this role.

created_atstringoptional

Present for custom roles only.

accountobjectoptional

User account details (when expanded).

Show properties

idstringoptional

emailstringoptional

first_namestringoptional

last_namestringoptional

avatar_urlstringoptional

is_confirmedbooleanoptional

is_ssobooleanoptional

created_byobjectoptional

Account that created this record.

Show properties

idstringoptional

emailstringoptional

first_namestringoptional

last_namestringoptional

avatar_urlstringoptional

get/admin/company/access/{id}

GET /api/admin/company/access/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200The access record.

{
  "result": {
    "id": "string",
    "is_active": false,
    "is_transferred": false,
    "sso_account_id": "string",
    "sso_provider": {},
    "created_at": "string",
    "role": {
      "id": 0,
      "code": "string",
      "name": "string",
      "description": "string",
      "api_permissions": ["string"],
      "ui_permissions": ["string"],
      "is_active": false,
      "property_ids": ["string"],
      "is_system": false,
      "custom_type": "USER",
      "company_id": "string",
      "access_count": 0,
      "created_at": "string"
    },
    "account": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string",
      "is_confirmed": false,
      "is_sso": false
    },
    "created_by": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }
}

Update access

PUT

Update an access record.

Path parameters:

Name	Type	Required	Description
`id`	string	Yes	The access record ID.

Request bodyapplication/json

role_idstringoptional

New role ID to assign.

is_activebooleanoptional

Enable or disable access.

200Change status.application/json

resultobjectoptional

Show properties

changedstring[]optional

Names of fields that changed; empty/false when nothing changed.

put/admin/company/access/{id}

PUT /api/admin/company/access/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "role_id": "string",
  "is_active": false
}

200Change status.

{
  "result": {
    "changed": ["string"]
  }
}

Delete access

DELETE

Remove a user's access.

Path parameters:

Name	Type	Required	Description
`id`	string	Yes	The access record ID.

200Deletion confirmation.application/json

resultobjectoptional

Show properties

deletedbooleanoptional

delete/admin/company/access/{id}

DELETE /api/admin/company/access/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Deletion confirmation.

{
  "result": {
    "deleted": false
  }
}

Send invite

POST

Resend the invitation email.

Path parameters:

Name	Type	Required	Description
`id`	string	Yes	The access record ID.

200Invitation sent.application/json

resultobjectoptional

Show properties

sentbooleanoptional

post/admin/company/access/{id}/invite

POST /api/admin/company/access/{id}/invite HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Invitation sent.

{
  "result": {
    "sent": false
  }
}