# API reference

A list of public API operations: sections, documentation pages, and signatures. The contents and order match the interactive [reference](/docs/api-reference) and the sidebar. The common request and response format is described in the [API overview](/docs/entity-api).

Each line links to an operation page with parameters, examples, and error codes. Overview pages that do not describe a single operation are reachable from their section pages. A scope is shown next to the section name where the reference cards require one.

<!-- BEGIN GENERATED: api-reference-hub -->

## API basics

### [Batch API](/docs/batch) · `bizproc` `booking` `calendar` `catalog` `crm` `department` `disk` `documentgenerator` `humanresources` `imopenlines` `landing` `mail` `sale` `sonet_group` `task` `tasks` `telephony` `user`

- [Batch calls](/docs/batch) — 62 operations

## Keys & access

### [Marketplace trial](/docs/activate-market-trial)

- [Activate the Marketplace trial](/docs/activate-market-trial) — `POST /v1/portals/*/activate-market-trial`

### [Keys & Auth](/docs/keys-auth)

- [Key self-description](/docs/keys-auth/me) — `POST /v1/key-claim` `GET /v1/me`
- [API reference for the model](/docs/keys-auth/guide) — `GET /v1/guide`
- [Application user authorization](/docs/keys-auth/oauth) — 6 operations

### [Management Keys](/docs/management-keys) · `vibe:mgmt:keys` `vibe:mgmt:portals`

- [List Bitrix24 account API keys](/docs/management-keys/list) — `GET /v1/keys`
- [Create an API key](/docs/management-keys/create) — `POST /v1/keys`
- [Get an API key](/docs/management-keys/get) — `GET /v1/keys/*`
- [Update an API key](/docs/management-keys/update) — `PATCH /v1/keys/*`
- [Delete an API key](/docs/management-keys/delete) — `DELETE /v1/keys/*`
- [Rotate an API key](/docs/management-keys/rotate) — `POST /v1/keys/*/rotate`
- [List Bitrix24 accounts](/docs/management-keys/portals) — `GET /v1/portals`

### [Partner Connect](/docs/partner-connect)

- [Partner Connect](/docs/partner-connect) — 5 operations

## Applications

### [App blueprints](/docs/app-blueprints)

- [App blueprints](/docs/app-blueprints) — `GET /v1/app/blueprints/*`

### [Application catalog](/docs/applications) · `vibe:infra`

- [Deliver the result of a long-running method](/docs/applications/solution-call-result) — `POST /v1/solution-calls/*/result`
- [Send a solution event](/docs/applications/solution-event) — `POST /v1/solution-events`
- [Application secrets](/docs/applications/app-secrets) — subsection overview
- [List application secrets](/docs/applications/app-secrets/list) — `GET /v1/applications/*/secrets`
- [Create a secret name](/docs/applications/app-secrets/create) — `POST /v1/applications/*/secrets`
- [Delete a secret](/docs/applications/app-secrets/delete) — `DELETE /v1/applications/*/secrets/*`
- [Application connectors](/docs/applications/connectors) — `GET /v1/applications/*/connectors` `POST /v1/applications/*/connectors/*/access-request`
- [List applications](/docs/applications/list) — `GET /v1/applications`
- [Application card](/docs/applications/get) — `GET /v1/applications/*`
- [Servers for moving an application](/docs/applications/available-servers) — `GET /v1/applications/*/available-servers`
- [Replace an application server](/docs/applications/replace-server) — `POST /v1/applications/*/replace-server`

### [Apps and publishing](/docs/apps) · `placement`

- [Placements](/docs/apps/placements) — subsection overview
- [Bound placements](/docs/apps/placements/list) — `GET /v1/placements`
- [Available placements](/docs/apps/placements/available) — `GET /v1/placements/available`
- [Bind a placement](/docs/apps/placements/bind) — `POST /v1/placements/bind`
- [Unbind a placement](/docs/apps/placements/unbind) — `POST /v1/placements/unbind`
- [List applications](/docs/apps/list) — `GET /v1/apps`
- [Create an application](/docs/apps/create) — `POST /v1/apps`
- [Application data](/docs/apps/get) — `GET /v1/apps/*`
- [Update an application](/docs/apps/update) — `PATCH /v1/apps/*`
- [Delete an application](/docs/apps/delete) — `DELETE /v1/apps/*`
- [Relink an application](/docs/apps/relink-oauth) — `POST /v1/apps/*/relink-oauth`
- [Publish app](/docs/apps/publish) — `POST /v1/apps/*/publish`
- [Unpublish](/docs/apps/unpublish) — `POST /v1/apps/*/unpublish`

## Servers and deployment

### [Infrastructure](/docs/infra) · `vibe:infra`

- [Providers and catalogs](/docs/infra/providers) — subsection overview
- [List of providers](/docs/infra/providers/list) — `GET /v1/infra/providers`
- [Provider plans](/docs/infra/providers/plans) — `GET /v1/infra/providers/*/plans`
- [Provider regions](/docs/infra/providers/regions) — `GET /v1/infra/providers/*/regions`
- [Provider OS images](/docs/infra/providers/images) — `GET /v1/infra/providers/*/images`
- [Servers](/docs/infra/servers) — subsection overview
- [Create a server](/docs/infra/servers/create) — `POST /v1/infra/servers`
- [List servers](/docs/infra/servers/list) — `GET /v1/infra/servers`
- [Get a server](/docs/infra/servers/get) — `GET /v1/infra/servers/*`
- [Update the server name and description](/docs/infra/servers/update) — `PATCH /v1/infra/servers/*`
- [Delete a server](/docs/infra/servers/delete) — `DELETE /v1/infra/servers/*`
- [Access and modes](/docs/infra/access) — subsection overview
- [SSH credentials](/docs/infra/access/ssh) — `GET /v1/infra/servers/*/ssh`
- [Lifecycle](/docs/infra/lifecycle) — subsection overview
- [Stop the server](/docs/infra/lifecycle/stop) — `POST /v1/infra/servers/*/stop`
- [Application database](/docs/infra/database) — subsection overview
- [Get database information](/docs/infra/database/info) — `GET /v1/infra/servers/*/db`
- [Get host preparation status](/docs/infra/database/prepare-status) — `GET /v1/infra/servers/*/app-db/prepare`
- [Prepare the host](/docs/infra/database/prepare) — `POST /v1/infra/servers/*/app-db/prepare`
- [List database backups](/docs/infra/database/backups) — `GET /v1/infra/servers/*/db/backups`
- [Create a database backup](/docs/infra/database/snapshot) — `POST /v1/infra/servers/*/db/backups`
- [Restore the database from a backup](/docs/infra/database/restore) — `POST /v1/infra/servers/*/db/restore`
- [Get the database schema](/docs/infra/database/schema) — `GET /v1/infra/servers/*/db/schema`
- [Run a read-only SQL query](/docs/infra/database/query) — `POST /v1/infra/servers/*/db/query`
- [Get table rows](/docs/infra/database/rows) — `GET /v1/infra/servers/*/db/tables/*/rows`
- [Add a row](/docs/infra/database/rows-create) — `POST /v1/infra/servers/*/db/tables/*/rows`
- [Run write SQL](/docs/infra/database/execute) — `POST /v1/infra/servers/*/db/execute`
- [Update a row](/docs/infra/database/rows-update) — `PATCH /v1/infra/servers/*/db/tables/*/rows/*`
- [Delete a row](/docs/infra/database/rows-delete) — `DELETE /v1/infra/servers/*/db/tables/*/rows/*`
- [Start the server](/docs/infra/lifecycle/start) — `POST /v1/infra/servers/*/start`
- [Check an access change request](/docs/infra/access/audience-proposals-get) — `GET /v1/infra/servers/*/audience-proposals/*`
- [Cancel an access request](/docs/infra/access/audience-proposals-cancel) — `POST /v1/infra/servers/*/audience-proposals/*/cancel`
- [Access policy](/docs/infra/access/access-policy) — `PATCH /v1/infra/servers/*/access-policy`
- [Reboot server](/docs/infra/lifecycle/reboot) — `POST /v1/infra/servers/*/reboot`
- [Sleep now](/docs/infra/lifecycle/sleep-now) — `POST /v1/infra/servers/*/sleep-now`
- [Configure auto-sleep](/docs/infra/lifecycle/sleep) — `PATCH /v1/infra/servers/*/sleep`
- [Set the server run mode](/docs/infra/lifecycle/run-mode) — `PATCH /v1/infra/servers/*/run-mode`
- [Work schedule library](/docs/infra/work-schedules) — subsection overview
- [List schedules](/docs/infra/work-schedules/list) — `GET /v1/work-schedules`
- [Create a schedule](/docs/infra/work-schedules/create) — `POST /v1/work-schedules`
- [Get a schedule](/docs/infra/work-schedules/get) — `GET /v1/work-schedules/*`
- [Update a schedule](/docs/infra/work-schedules/update) — `PATCH /v1/work-schedules/*`
- [Delete a schedule](/docs/infra/work-schedules/delete) — `DELETE /v1/work-schedules/*`
- [Set the default schedule](/docs/infra/work-schedules/set-default) — `PUT /v1/work-schedules/*/default`
- [Refresh status](/docs/infra/lifecycle/refresh) — `POST /v1/infra/servers/*/refresh`
- [Switch mode](/docs/infra/access/mode) — `PATCH /v1/infra/servers/*/mode`
- [Deploy API](/docs/infra/deploy) — subsection overview
- [Set the application port](/docs/infra/deploy/port) — `PATCH /v1/infra/servers/*/port`
- [Access list](/docs/infra/access/access-list) — `GET /v1/infra/servers/*/access`
- [Add user or department](/docs/infra/access/access-add) — `POST /v1/infra/servers/*/access`
- [Delete access entry](/docs/infra/access/access-delete) — `DELETE /v1/infra/servers/*/access/*`
- [Tunnel metrics](/docs/infra/deploy/metrics) — `GET /v1/infra/servers/*/metrics`
- [Search Bitrix24 users](/docs/infra/access/b24-users) — `GET /v1/infra/servers/*/b24-users`
- [Repair tunnel](/docs/infra/lifecycle/repair) — `POST /v1/infra/servers/*/repair`
- [Run a command](/docs/infra/deploy/exec) — `POST /v1/infra/servers/*/exec`
- [Upload a file](/docs/infra/deploy/upload) — `POST /v1/infra/servers/*/upload`
- [Service logs](/docs/infra/deploy/logs) — `GET /v1/infra/servers/*/logs`
- [Full application deploy](/docs/infra/deploy/deploy) — `POST /v1/infra/servers/*/deploy`
- [Release a stuck lock](/docs/infra/deploy/lock) — `DELETE /v1/infra/servers/*/lock`
- [List of runtimes](/docs/infra/deploy/runtimes) — `GET /v1/infra/runtimes`
- [Wake server](/docs/infra/lifecycle/wake) — `POST /v1/infra/servers/*/wake`
- [Publish the app to the Bitrix24 catalog](/docs/infra/servers/b24-catalog-publish) — `POST /v1/infra/servers/*/b24-catalog/publish`
- [Repair status](/docs/infra/lifecycle/repair-status) — `GET /v1/infra/servers/*/repair-status`
- [Operation outcome](/docs/infra/deploy/operation-status) — `GET /v1/infra/operations/*`
- [Recent server operations](/docs/infra/deploy/operations) — `GET /v1/infra/servers/*/operations`
- [Server activity feed](/docs/infra/servers/activity) — `GET /v1/infra/servers/*/activity`
- [Operation outcome from the server feed](/docs/infra/deploy/server-operation) — `GET /v1/infra/servers/*/operations/*`
- [Custom domain](/docs/infra/domain) — subsection overview
- [Attach a domain](/docs/infra/domain/attach) — `POST /v1/infra/servers/*/domain`
- [Get the domain](/docs/infra/domain/get) — `GET /v1/infra/servers/*/domain`
- [Detach a domain](/docs/infra/domain/detach) — `DELETE /v1/infra/servers/*/domain`
- [Verify the domain](/docs/infra/domain/verify) — `POST /v1/infra/servers/*/domain/verify`
- [Access tokens](/docs/infra/access-tokens) — subsection overview
- [Mint an access token](/docs/infra/access-tokens/create) — `POST /v1/infra/servers/*/access-tokens`
- [List server tokens](/docs/infra/access-tokens/list) — `GET /v1/infra/servers/*/access-tokens`
- [Revoke a token](/docs/infra/access-tokens/delete) — `DELETE /v1/infra/servers/*/access-tokens/*`
- [Refresh an access token](/docs/infra/access-tokens/refresh) — `POST /v1/infra/servers/*/access-tokens/*/refresh`
- [Signed resource URL](/docs/infra/access-tokens/resource-url) — `POST /v1/infra/servers/*/access-tokens/*/resource-url`
- [Bitrix24 event subscriptions](/docs/infra/event-subscriptions) — subsection overview
- [Create a subscription](/docs/infra/event-subscriptions/create) — `POST /v1/infra/servers/*/event-subscriptions`
- [List subscriptions](/docs/infra/event-subscriptions/list) — `GET /v1/infra/servers/*/event-subscriptions`
- [Delete a subscription](/docs/infra/event-subscriptions/delete) — `DELETE /v1/infra/servers/*/event-subscriptions/*`
- [Scheduled wake](/docs/infra/wake-schedules) — subsection overview
- [List wake windows](/docs/infra/wake-schedules/list) — `GET /v1/infra/servers/*/wake-schedules`
- [Create a wake window](/docs/infra/wake-schedules/create) — `POST /v1/infra/servers/*/wake-schedules`
- [Update a wake window](/docs/infra/wake-schedules/update) — `PATCH /v1/infra/servers/*/wake-schedules/*`
- [Delete a wake window](/docs/infra/wake-schedules/delete) — `DELETE /v1/infra/servers/*/wake-schedules/*`
- [Upload an app icon](/docs/infra/app-icon) — `POST /v1/infra/servers/*/icon`
- [Unstick the channel](/docs/infra/servers/unstick) — `POST /v1/infra/servers/*/unstick`

### [Scheduled HTTP calls](/docs/infra/jobs) · `vibe:infra`

- [List jobs](/docs/infra/jobs/list) — `GET /v1/infra/servers/*/jobs`
- [Create a job](/docs/infra/jobs/create) — `POST /v1/infra/servers/*/jobs`
- [Replace job settings](/docs/infra/jobs/update) — `PATCH /v1/infra/servers/*/jobs/*`
- [Delete a job](/docs/infra/jobs/delete) — `DELETE /v1/infra/servers/*/jobs/*`
- [Run manually](/docs/infra/jobs/run) — `POST /v1/infra/servers/*/jobs/*/run`
- [Rotate the secret](/docs/infra/jobs/rotate-secret) — `POST /v1/infra/servers/*/jobs/*/rotate-secret`
- [Run history](/docs/infra/jobs/runs) — `GET /v1/infra/servers/*/jobs/*/runs`

### [Source Storage](/docs/source-storage) · `vibe:infra`

- [List versions](/docs/source-storage/versions) — `GET /v1/apps/*/sources`
- [Save a snapshot](/docs/source-storage/save) — `POST /v1/apps/*/sources`
- [Get version metadata](/docs/source-storage/versions-get) — `GET /v1/apps/*/sources/*`
- [Update version metadata](/docs/source-storage/metadata-update) — `PATCH /v1/apps/*/sources/*`
- [Delete a version](/docs/source-storage/delete) — `DELETE /v1/apps/*/sources/*`
- [Download the archive](/docs/source-storage/versions-download) — `GET /v1/apps/*/sources/*/download`
- [Set or remove a tag](/docs/source-storage/metadata-tag) — `POST /v1/apps/*/sources/*/tag`
- [Clear old versions](/docs/source-storage/cleanup) — `POST /v1/apps/*/sources/cleanup`
- [Source code storage](/docs/source-storage) — 8 operations
- [Source registry and Bitrix24 account state](/docs/source-storage/registry) — `GET /v1/me/sources`

### [Storage](/docs/storage)

- [Upload](/docs/storage/upload) — subsection overview
- [Create presigned URL](/docs/storage/upload/presigned) — `POST /v1/storage/objects`
- [Objects](/docs/storage/objects) — subsection overview
- [List objects](/docs/storage/objects/list) — `GET /v1/storage/objects`
- [Complete upload](/docs/storage/upload/complete) — `POST /v1/storage/objects/complete`
- [Direct file upload](/docs/storage/upload/direct) — `POST /v1/storage/objects/upload`
- [Create multipart upload](/docs/storage/upload/multipart-create) — `POST /v1/storage/objects/multipart/create`
- [Complete multipart upload](/docs/storage/upload/multipart-complete) — `POST /v1/storage/objects/multipart/complete`
- [Abort multipart upload](/docs/storage/upload/multipart-abort) — `POST /v1/storage/objects/multipart/abort`
- [Download object](/docs/storage/objects/get) — `GET /v1/storage/objects/*`
- [Object metadata](/docs/storage/objects/head) — `HEAD /v1/storage/objects/*`
- [Delete object](/docs/storage/objects/delete) — `DELETE /v1/storage/objects/*`
- [Public access to an object](/docs/storage/objects/public-get) — `GET /v1/public-storage/*/*`
- [Public object metadata](/docs/storage/objects/public-head) — `HEAD /v1/public-storage/*/*`

## AI

### [AI agents](/docs/agents)

- [List AI agents](/docs/agents/list) — `GET /v1/agents`

### [AI Router](/docs/ai) · `vibe:ai`

- [Models](/docs/ai/models) — subsection overview
- [List models](/docs/ai/models/list) — `GET /v1/models` `GET /v1/ai/models`
- [Chat completions](/docs/ai/chat) — subsection overview
- [Create a chat completion](/docs/ai/chat/completions) — `POST /v1/chat/completions` `POST /v1/ai/chat/completions`
- [Speech recognition](/docs/ai/audio) — subsection overview
- [Transcribe audio](/docs/ai/audio/transcriptions) — `POST /v1/audio/transcriptions` `POST /v1/ai/audio/transcriptions`
- [Create embeddings](/docs/ai/embeddings) — `POST /v1/embeddings` `POST /v1/ai/embeddings`
- [Your own keys (BYOK)](/docs/ai/credentials) — subsection overview
- [List keys](/docs/ai/credentials/list) — `GET /v1/ai/credentials`
- [Connect a provider key](/docs/ai/credentials/create) — `POST /v1/ai/credentials`
- [Update a provider key](/docs/ai/credentials/update) — `PATCH /v1/ai/credentials/*`
- [Delete a provider key](/docs/ai/credentials/delete) — `DELETE /v1/ai/credentials/*`
- [Test a provider key](/docs/ai/credentials/test) — `POST /v1/ai/credentials/*/test`
- [Key usage stats](/docs/ai/credentials/usage) — `GET /v1/ai/credentials/*/usage`
- [Fetch the model catalog](/docs/ai/credentials/fetch-models) — `POST /v1/ai/credentials/*/fetch-models`
- [Preview available models](/docs/ai/credentials/available-models) — `GET /v1/ai/credentials/*/available-models`
- [List a key's models](/docs/ai/credentials/models-list) — `GET /v1/ai/credentials/*/models`
- [Add a model manually](/docs/ai/credentials/models-add) — `POST /v1/ai/credentials/*/models`
- [Delete a key's model](/docs/ai/credentials/models-delete) — `DELETE /v1/ai/credentials/*/models/*`
- [Provider list](/docs/ai/credentials/providers) — `GET /v1/ai/providers`
- [Usage and limits](/docs/ai/consumption) — subsection overview
- [Usage statistics](/docs/ai/consumption/usage) — `GET /v1/ai/usage`
- [Company AI quota](/docs/ai/consumption/quota) — `GET /v1/ai/quota`
- [Off-peak schedule](/docs/ai/consumption/off-peak) — `GET /v1/off-peak`

### [Cowork](/docs/cowork)

- [Cowork subscription state](/docs/cowork/state) — `GET /v1/cowork/state`
- [Announcing a new model in Cowork](/docs/cowork/model-announcement) — `PUT /v1/cowork/model-preference` `POST /v1/cowork/model-announcement/*/events`
- [Cowork subscription summary](/docs/cowork/me) — `GET /v1/cowork/me`
- [Tier change preview for Cowork](/docs/cowork/subscription-preview) — `GET /v1/cowork/subscription/preview`
- [Project deployment key](/docs/cowork/deploy-key) — `POST /v1/cowork/deploy-key`
- [Application creation parameters](/docs/cowork/applications-defaults) — `GET /v1/cowork/applications/defaults`
- [Create an application from Cowork](/docs/cowork/applications-create) — `POST /v1/cowork/applications`
- [Issue or replace an application key](/docs/cowork/applications-key) — `POST /v1/cowork/applications/*/key`

### [Web Search for AI](/docs/search)

- [Search](/docs/search/run) — `POST /v1/search`
- [Deep research](/docs/search/research) — `POST /v1/research`
- [Provider list](/docs/search/providers) — `GET /v1/search/providers`
- [Your own keys (BYOK)](/docs/search/credentials) — subsection overview
- [List your keys](/docs/search/credentials/list) — `GET /v1/search/credentials`
- [Add a key](/docs/search/credentials/create) — `POST /v1/search/credentials`
- [Delete a key](/docs/search/credentials/delete) — `DELETE /v1/search/credentials/*`
- [Test a key](/docs/search/credentials/test) — `POST /v1/search/credentials/*/test`

## CRM

### [Automation](/docs/automation) · `bizproc` `crm`

- [Workflows](/docs/automation/workflows) — subsection overview
- [List of running workflows](/docs/automation/workflows/list) — `GET /v1/workflows`
- [Terminate a workflow](/docs/automation/workflows/terminate) — `DELETE /v1/workflows/*`
- [Send an event to a process](/docs/automation/workflows/event) — `POST /v1/workflows/event`
- [Triggers](/docs/automation/triggers) — subsection overview
- [Automation trigger list](/docs/automation/triggers/list) — `GET /v1/triggers`
- [Fire a trigger](/docs/automation/triggers/fire) — `POST /v1/triggers/fire`
- [Write to the workflow log](/docs/automation/workflows/activity-log) — `POST /v1/workflows/activity-log`
- [Business-process tasks](/docs/automation/bizproc-tasks) — subsection overview
- [List tasks](/docs/automation/bizproc-tasks/list) — `GET /v1/bizproc-tasks`
- [Complete a task](/docs/automation/bizproc-tasks/complete) — `POST /v1/bizproc-tasks/*/complete`
- [Delegate tasks](/docs/automation/bizproc-tasks/delegate) — `POST /v1/bizproc-tasks/delegate`
- [Start a workflow](/docs/automation/workflows/start) — `POST /v1/workflows/start`

### [Duplicate search](/docs/duplicates) · `crm`

- [Duplicate search](/docs/duplicates) — `POST /v1/duplicates/find`

### [Activities](/docs/entities/activities) · `crm`

- [Activities of a CRM record](/docs/entities/activities/owner-list) — `GET /v1/deals/*/activities` `GET /v1/contacts/*/activities` `GET /v1/companies/*/activities` `GET /v1/leads/*/activities`
- [Create an activity for a CRM record](/docs/entities/activities/owner-create) — `POST /v1/deals/*/activities` `POST /v1/contacts/*/activities` `POST /v1/companies/*/activities` `POST /v1/leads/*/activities`
- [List activities](/docs/entities/activities/list) — `GET /v1/activities`
- [Create activity](/docs/entities/activities/create) — `POST /v1/activities`
- [Get activity](/docs/entities/activities/get) — `GET /v1/activities/*`
- [Update activity](/docs/entities/activities/update) — `PATCH /v1/activities/*`
- [Delete activity](/docs/entities/activities/delete) — `DELETE /v1/activities/*`
- [Search activities](/docs/entities/activities/search) — `POST /v1/activities/search`
- [Aggregate activities](/docs/entities/activities/aggregate) — `POST /v1/activities/aggregate`
- [Activity fields](/docs/entities/activities/fields) — `GET /v1/activities/fields`
- [CRM call transcripts](/docs/entities/activities/transcript) — `GET /v1/activities/*/transcript`
- [Download an activity file](/docs/entities/activities/file-download) — `GET /v1/activities/*/files/*/download`
- [Configurable activities](/docs/entities/activities/configurable) — subsection overview
- [Create activity](/docs/entities/activities/configurable/create) — `POST /v1/activity-configurable`
- [Get activity](/docs/entities/activities/configurable/get) — `GET /v1/activity-configurable/*`
- [Update activity](/docs/entities/activities/configurable/update) — `PATCH /v1/activity-configurable/*`
- [CRM to-dos](/docs/entities/activities/todos) — subsection overview
- [Create a to-do](/docs/entities/activities/todos/create) — `POST /v1/activity-todos`
- [Update a to-do](/docs/entities/activities/todos/update) — `PATCH /v1/activity-todos/*`
- [Activity bindings](/docs/entities/activities/bindings) — subsection overview
- [List bindings](/docs/entities/activities/bindings/list) — `GET /v1/activities/*/bindings`
- [Bind](/docs/entities/activities/bindings/bind) — `POST /v1/activities/*/bindings`
- [Unbind](/docs/entities/activities/bindings/unbind) — `DELETE /v1/activities/*/bindings`
- [Move a binding](/docs/entities/activities/bindings/move) — `POST /v1/activities/*/bindings/move`
- [Complete an activity](/docs/entities/activities/complete) — `POST /v1/activities/*/complete`
- [Postpone an activity](/docs/entities/activities/postpone) — `POST /v1/activities/*/postpone`
- [Change an activity deadline](/docs/entities/activities/deadline) — `POST /v1/activities/*/deadline`

### [Addresses](/docs/entities/addresses) · `crm`

- [Address fields](/docs/entities/addresses/fields) — `GET /v1/addresses/fields`
- [List addresses](/docs/entities/addresses/list) — `GET /v1/addresses`
- [Create address](/docs/entities/addresses/create) — `POST /v1/addresses`
- [Search addresses](/docs/entities/addresses/search) — `POST /v1/addresses/search`
- [Get address](/docs/entities/addresses/get) — `GET /v1/addresses/*/*/*`
- [Update address](/docs/entities/addresses/update) — `PATCH /v1/addresses/*/*/*`
- [Delete address](/docs/entities/addresses/delete) — `DELETE /v1/addresses/*/*/*`

### [Digital workspaces](/docs/entities/automated-solutions) · `crm`

- [List workspaces](/docs/entities/automated-solutions/list) — `GET /v1/automated-solutions`
- [Create workspace](/docs/entities/automated-solutions/create) — `POST /v1/automated-solutions`
- [Get a workspace](/docs/entities/automated-solutions/get) — `GET /v1/automated-solutions/*`
- [Update workspace](/docs/entities/automated-solutions/update) — `PATCH /v1/automated-solutions/*`
- [Delete workspace](/docs/entities/automated-solutions/delete) — `DELETE /v1/automated-solutions/*`
- [Workspace fields](/docs/entities/automated-solutions/fields) — `GET /v1/automated-solutions/fields`

### [Bank details](/docs/entities/bank-details) · `crm`

- [List bank details](/docs/entities/bank-details/list) — `GET /v1/bank-details`
- [Create bank detail](/docs/entities/bank-details/create) — `POST /v1/bank-details`
- [Get bank detail](/docs/entities/bank-details/get) — `GET /v1/bank-details/*`
- [Update bank detail](/docs/entities/bank-details/update) — `PATCH /v1/bank-details/*`
- [Delete bank detail](/docs/entities/bank-details/delete) — `DELETE /v1/bank-details/*`
- [Search bank details](/docs/entities/bank-details/search) — `POST /v1/bank-details/search`
- [Bank detail fields](/docs/entities/bank-details/fields) — `GET /v1/bank-details/fields`

### [Call lists](/docs/entities/call-lists) · `crm`

- [List call lists](/docs/entities/call-lists/list) — `GET /v1/call-lists`
- [Create a call list](/docs/entities/call-lists/create) — `POST /v1/call-lists`
- [Get a call list](/docs/entities/call-lists/get) — `GET /v1/call-lists/*`
- [Replace participants](/docs/entities/call-lists/replace) — `PUT /v1/call-lists/*`
- [List participants](/docs/entities/call-lists/items) — `GET /v1/call-lists/*/items`
- [Participant statuses](/docs/entities/call-lists/statuses) — `GET /v1/call-lists/statuses`

### [Pipelines](/docs/entities/categories) · `crm`

- [List funnels](/docs/entities/categories/list) — `GET /v1/categories/*`
- [Create a pipeline](/docs/entities/categories/create) — `POST /v1/categories/*`
- [Get pipeline](/docs/entities/categories/get) — `GET /v1/categories/*/*`
- [Update a pipeline](/docs/entities/categories/update) — `PATCH /v1/categories/*/*`
- [Delete a pipeline](/docs/entities/categories/delete) — `DELETE /v1/categories/*/*`
- [Search funnels](/docs/entities/categories/search) — `POST /v1/categories/*/search`
- [Funnel fields](/docs/entities/categories/fields) — `GET /v1/categories/*/fields`

### [Companies](/docs/entities/companies) · `crm`

- [List companies](/docs/entities/companies/list) — `GET /v1/companies`
- [Create company](/docs/entities/companies/create) — `POST /v1/companies`
- [Get company](/docs/entities/companies/get) — `GET /v1/companies/*`
- [Update company](/docs/entities/companies/update) — `PATCH /v1/companies/*`
- [Delete company](/docs/entities/companies/delete) — `DELETE /v1/companies/*`
- [Search companies](/docs/entities/companies/search) — `POST /v1/companies/search`
- [Aggregate companies](/docs/entities/companies/aggregate) — `POST /v1/companies/aggregate`
- [Company fields](/docs/entities/companies/fields) — `GET /v1/companies/fields`
- [List company contacts](/docs/entities/companies/contacts-list) — `GET /v1/companies/*/contacts`
- [Link a contact to a company](/docs/entities/companies/contacts-create) — `POST /v1/companies/*/contacts`
- [Replace company contacts](/docs/entities/companies/contacts-set) — `PUT /v1/companies/*/contacts`
- [Unlink all contacts from a company](/docs/entities/companies/contacts-delete) — `DELETE /v1/companies/*/contacts`
- [Unlink a contact from a company](/docs/entities/companies/contacts-delete-delete) — `DELETE /v1/companies/*/contacts/*`

### [Contacts](/docs/entities/contacts) · `crm`

- [List contacts](/docs/entities/contacts/list) — `GET /v1/contacts`
- [Create contact](/docs/entities/contacts/create) — `POST /v1/contacts`
- [Get contact](/docs/entities/contacts/get) — `GET /v1/contacts/*`
- [Update contact](/docs/entities/contacts/update) — `PATCH /v1/contacts/*`
- [Delete contact](/docs/entities/contacts/delete) — `DELETE /v1/contacts/*`
- [Search contacts](/docs/entities/contacts/search) — `POST /v1/contacts/search`
- [Aggregate contacts](/docs/entities/contacts/aggregate) — `POST /v1/contacts/aggregate`
- [Contact fields](/docs/entities/contacts/fields) — `GET /v1/contacts/fields`
- [List contact companies](/docs/entities/contacts/companies-list) — `GET /v1/contacts/*/companies`
- [Link a company to a contact](/docs/entities/contacts/companies-create) — `POST /v1/contacts/*/companies`
- [Replace contact companies](/docs/entities/contacts/companies-set) — `PUT /v1/contacts/*/companies`
- [Unlink all companies from a contact](/docs/entities/contacts/companies-delete) — `DELETE /v1/contacts/*/companies`
- [Unlink a company from a contact](/docs/entities/contacts/companies-delete-delete) — `DELETE /v1/contacts/*/companies/*`

### [CRM card layout](/docs/entities/crm-card-config) · `crm`

- [Get card layout](/docs/entities/crm-card-config/get) — `GET /v1/crm/card-config/*`
- [Set card layout](/docs/entities/crm-card-config/set) — `PUT /v1/crm/card-config/*`
- [Reset card layout](/docs/entities/crm-card-config/reset) — `DELETE /v1/crm/card-config/*`
- [Common layout for all employees](/docs/entities/crm-card-config/force-common) — `POST /v1/crm/card-config/*/force-common`

### [Named CRM card layouts](/docs/entities/crm-card-layouts) · `crm`

- [List CRM card layouts](/docs/entities/crm-card-layouts/list) — `GET /v1/crm/card-layouts/*`
- [Create a CRM card layout](/docs/entities/crm-card-layouts/add) — `POST /v1/crm/card-layouts/*`
- [Select the current CRM layout](/docs/entities/crm-card-layouts/setcurrent) — `PUT /v1/crm/card-layouts/*/current`
- [Get the common CRM layout ID](/docs/entities/crm-card-layouts/getcommonlayoutid) — `GET /v1/crm/card-layouts/*/common-id`
- [Get the personal CRM layout ID](/docs/entities/crm-card-layouts/getpersonallayoutid) — `GET /v1/crm/card-layouts/*/personal-id`
- [Get a CRM card layout](/docs/entities/crm-card-layouts/get) — `GET /v1/crm/card-layouts/*/*`
- [Update a CRM card layout](/docs/entities/crm-card-layouts/update) — `PATCH /v1/crm/card-layouts/*/*`
- [Delete a CRM card layout](/docs/entities/crm-card-layouts/delete) — `DELETE /v1/crm/card-layouts/*/*`

### [CRM deliveries](/docs/entities/crm-deliveries) · `crm`

- [List CRM deliveries](/docs/entities/crm-deliveries/list) — `GET /v1/crm-deliveries`
- [Get a CRM delivery](/docs/entities/crm-deliveries/get) — `GET /v1/crm-deliveries/*`

### [CRM e-mails](/docs/entities/crm-emails) · `crm`

- [Get CRM e-mail content](/docs/entities/crm-emails/get) — `GET /v1/crm-emails/*`
- [Get a CRM e-mail thread](/docs/entities/crm-emails/thread) — `GET /v1/crm-emails/*/thread`
- [Reply to a CRM e-mail](/docs/entities/crm-emails/reply) — `POST /v1/crm-emails/*/reply`
- [List CRM e-mails](/docs/entities/crm-emails/list) — `GET /v1/deals/*/emails` `GET /v1/leads/*/emails` `GET /v1/contacts/*/emails` `GET /v1/companies/*/emails`
- [Send a CRM e-mail](/docs/entities/crm-emails/send) — `POST /v1/deals/*/emails` `POST /v1/leads/*/emails` `POST /v1/contacts/*/emails` `POST /v1/companies/*/emails`

### [CRM enums](/docs/entities/crm-enums) · `crm`

- [CRM entity types](/docs/entities/crm-enums/owner-types) — `GET /v1/crm-enums/owner-types`
- [CRM address types](/docs/entities/crm-enums/address-types) — `GET /v1/crm-enums/address-types`

### [CRM list field values](/docs/entities/crm-field-enum) · `crm`

- [List enumeration field values](/docs/entities/crm-field-enum/list) — 7 operations
- [Create an enumeration field value](/docs/entities/crm-field-enum/create) — 7 operations
- [Get an enumeration field value](/docs/entities/crm-field-enum/get) — 7 operations
- [Update a list field value](/docs/entities/crm-field-enum/update) — 7 operations
- [Delete a list field value](/docs/entities/crm-field-enum/delete) — 7 operations

### [CRM field values](/docs/entities/crm-field-values) · `crm`

- [Add one CRM field value](/docs/entities/crm-field-values/add) — 7 operations
- [Remove one CRM field value](/docs/entities/crm-field-values/delete) — 7 operations
- [Set the primary CRM contact](/docs/entities/crm-field-values/primary-contact) — 5 operations

### [CRM forms](/docs/entities/crm-forms) · `crm`

- [Submit visitor data](/docs/entities/crm-forms/results) — `POST /v1/crm-forms/*/results`
- [List forms](/docs/entities/crm-forms/list) — `GET /v1/crm-forms`
- [Create a form](/docs/entities/crm-forms/create) — `POST /v1/crm-forms`
- [Get a form](/docs/entities/crm-forms/get) — `GET /v1/crm-forms/*`
- [Update a form](/docs/entities/crm-forms/update) — `PATCH /v1/crm-forms/*`
- [Delete a form](/docs/entities/crm-forms/delete) — `DELETE /v1/crm-forms/*`
- [Get builder configuration](/docs/entities/crm-forms/configuration) — `GET /v1/crm-forms/configuration`
- [List scenarios](/docs/entities/crm-forms/scenarios) — `GET /v1/crm-forms/scenarios`
- [List scenario categories](/docs/entities/crm-forms/scenario-categories) — `GET /v1/crm-forms/scenario-categories`
- [List entity fields](/docs/entities/crm-forms/entity-fields) — `GET /v1/crm-forms/entity-fields`
- [Form contract fields](/docs/entities/crm-forms/fields) — `GET /v1/crm-forms/fields`
- [Get a form contract field](/docs/entities/crm-forms/field) — `GET /v1/crm-forms/fields/*`
- [Get form embedding codes](/docs/entities/crm-forms/embedding) — `GET /v1/crm-forms/*/embedding`
- [Update form embedding settings](/docs/entities/crm-forms/embedding-update) — `PATCH /v1/crm-forms/*/embedding`
- [List website widgets for a form](/docs/entities/crm-forms/site-buttons) — `GET /v1/crm-forms/*/site-buttons`
- [List Open Channels for a form](/docs/entities/crm-forms/openlines) — `GET /v1/crm-forms/*/openlines`
- [Validate a form](/docs/entities/crm-forms/validate) — `POST /v1/crm-forms/validate` `POST /v1/crm-forms/*/validate`
- [Activate a form](/docs/entities/crm-forms/activate) — `POST /v1/crm-forms/*/activate`
- [Deactivate a form](/docs/entities/crm-forms/deactivate) — `POST /v1/crm-forms/*/deactivate`

### [CRM payments](/docs/entities/crm-payments) · `crm`

- [List CRM payments](/docs/entities/crm-payments/list) — `GET /v1/crm-payments`
- [Create a CRM payment](/docs/entities/crm-payments/create) — `POST /v1/crm-payments`
- [Product rows available for CRM payment](/docs/entities/crm-payments/available-products) — `GET /v1/crm-payments/available-products`
- [Get a CRM payment](/docs/entities/crm-payments/get) — `GET /v1/crm-payments/*`
- [Update a CRM payment](/docs/entities/crm-payments/update) — `PATCH /v1/crm-payments/*`
- [Delete a CRM payment](/docs/entities/crm-payments/delete) — `DELETE /v1/crm-payments/*`
- [Mark a CRM payment as paid](/docs/entities/crm-payments/pay) — `POST /v1/crm-payments/*/pay`
- [Remove the paid mark from a CRM payment](/docs/entities/crm-payments/unpay) — `POST /v1/crm-payments/*/unpay`
- [List CRM payment line items](/docs/entities/crm-payments/products-list) — `GET /v1/crm-payments/*/products`
- [Add a line item to a CRM payment](/docs/entities/crm-payments/products-add) — `POST /v1/crm-payments/*/products`
- [Change the quantity in a CRM payment line item](/docs/entities/crm-payments/products-update) — `PATCH /v1/crm-payments/*/products/*`
- [Delete a line item from a CRM payment](/docs/entities/crm-payments/products-delete) — `DELETE /v1/crm-payments/*/products/*`

### [Required CRM fields](/docs/entities/crm-required-fields) · `crm`

- [Read a CRM field requirement](/docs/entities/crm-required-fields/get) — 7 operations
- [Set a CRM field requirement](/docs/entities/crm-required-fields/set) — 7 operations
- [Clear a CRM field requirement](/docs/entities/crm-required-fields/clear) — 7 operations

### [CRM search](/docs/entities/crm-search) · `crm`

- [Search CRM records](/docs/entities/crm-search/search) — `POST /v1/crm/search`

### [CRM settings](/docs/entities/crm-settings) · `crm`

- [CRM mode](/docs/entities/crm-settings/mode) — `GET /v1/crm-settings/mode`
- [List CRM settings](/docs/entities/crm-settings/list) — `GET /v1/crm-settings`
- [Get a CRM setting](/docs/entities/crm-settings/get) — `GET /v1/crm-settings/*`
- [Change a CRM setting](/docs/entities/crm-settings/update) — `PATCH /v1/crm-settings/*`

### [CRM traces](/docs/entities/crm-traces) · `crm`

- [Create a trace](/docs/entities/crm-traces/create) — `POST /v1/crm-traces`
- [Delete a trace](/docs/entities/crm-traces/delete) — `DELETE /v1/crm-traces/*`

### [REST v3: CRM dictionaries](/docs/entities/crm-v3-dictionaries) · `crm`

- [List CRM dictionary values](/docs/entities/crm-v3-dictionaries/list) — 6 operations
- [Get a CRM dictionary entry](/docs/entities/crm-v3-dictionaries/get) — 6 operations
- [Replace funnel stages](/docs/entities/crm-v3-dictionaries/stages-replace) — `PUT /v1/deal-categories/*/stages` `PUT /v1/categories/*/*/stages`
- [Enable leads](/docs/entities/crm-v3-dictionaries/leads-enable) — `POST /v1/leads/enable`
- [Disable leads](/docs/entities/crm-v3-dictionaries/leads-disable) — `POST /v1/leads/disable`

### [Currencies](/docs/entities/currencies) · `crm`

- [List currencies](/docs/entities/currencies/list) — `GET /v1/currencies`
- [Create currency](/docs/entities/currencies/create) — `POST /v1/currencies`
- [Get currency](/docs/entities/currencies/get) — `GET /v1/currencies/*`
- [Update currency](/docs/entities/currencies/update) — `PATCH /v1/currencies/*`
- [Delete currency](/docs/entities/currencies/delete) — `DELETE /v1/currencies/*`
- [Currency search](/docs/entities/currencies/search) — `POST /v1/currencies/search`
- [Currency aggregation](/docs/entities/currencies/aggregate) — `POST /v1/currencies/aggregate`
- [Currency fields](/docs/entities/currencies/fields) — `GET /v1/currencies/fields`
- [Base currency](/docs/entities/currencies/base) — `GET /v1/currencies/base`
- [Currency localizations](/docs/entities/currencies/localizations) — subsection overview
- [Currency localization fields](/docs/entities/currencies/localizations/fields) — `GET /v1/currencies/*/localizations/fields`
- [Get currency localizations](/docs/entities/currencies/localizations/get) — `GET /v1/currencies/*/localizations`
- [Set currency localizations](/docs/entities/currencies/localizations/set) — `PUT /v1/currencies/*/localizations`
- [Delete currency localizations](/docs/entities/currencies/localizations/delete) — `DELETE /v1/currencies/*/localizations`

### [Sales pipelines](/docs/entities/deal-categories) · `crm`

- [List funnels](/docs/entities/deal-categories/list) — `GET /v1/deal-categories`
- [Create a pipeline](/docs/entities/deal-categories/create) — `POST /v1/deal-categories`
- [Get a pipeline](/docs/entities/deal-categories/get) — `GET /v1/deal-categories/*`
- [Update a pipeline](/docs/entities/deal-categories/update) — `PATCH /v1/deal-categories/*`
- [Delete a pipeline](/docs/entities/deal-categories/delete) — `DELETE /v1/deal-categories/*`
- [Search funnels](/docs/entities/deal-categories/search) — `POST /v1/deal-categories/search`
- [Aggregate funnels](/docs/entities/deal-categories/aggregate) — `POST /v1/deal-categories/aggregate`
- [Funnel fields](/docs/entities/deal-categories/fields) — `GET /v1/deal-categories/fields`

### [Deals](/docs/entities/deals) · `crm`

- [List deals](/docs/entities/deals/list) — `GET /v1/deals`
- [Create deal](/docs/entities/deals/create) — `POST /v1/deals`
- [Get deal](/docs/entities/deals/get) — `GET /v1/deals/*`
- [Update deal](/docs/entities/deals/update) — `PATCH /v1/deals/*`
- [Delete deal](/docs/entities/deals/delete) — `DELETE /v1/deals/*`
- [Search deals](/docs/entities/deals/search) — `POST /v1/deals/search`
- [Aggregate deals](/docs/entities/deals/aggregate) — `POST /v1/deals/aggregate`
- [Deal fields](/docs/entities/deals/fields) — `GET /v1/deals/fields`
- [List deal contacts](/docs/entities/deals/contacts-list) — `GET /v1/deals/*/contacts`
- [Link a contact to a deal](/docs/entities/deals/contacts-create) — `POST /v1/deals/*/contacts`
- [Replace deal contacts](/docs/entities/deals/contacts-set) — `PUT /v1/deals/*/contacts`
- [Unlink all contacts from a deal](/docs/entities/deals/contacts-delete) — `DELETE /v1/deals/*/contacts`
- [Unlink a contact from a deal](/docs/entities/deals/contacts-delete-delete) — `DELETE /v1/deals/*/contacts/*`
- [Deal product rows](/docs/entities/deals/products-get) — `GET /v1/deals/*/products`
- [Set deal products](/docs/entities/deals/products-set) — `PUT /v1/deals/*/products`
- [Add a product to a deal](/docs/entities/deals/products-add) — `POST /v1/deals/*/products`
- [Deal product fields](/docs/entities/deals/products-fields) — `GET /v1/deals/*/products/fields`
- [Get a product from a deal](/docs/entities/deals/products-get-single) — `GET /v1/deals/*/products/*`
- [Update a deal product](/docs/entities/deals/products-update) — `PATCH /v1/deals/*/products/*`
- [Delete a product from a deal](/docs/entities/deals/products-delete) — `DELETE /v1/deals/*/products/*`
- [Move deal to another stage](/docs/entities/deals/move) — `POST /v1/deals/*/move`

### [Invoices](/docs/entities/invoices) · `crm`

- [List invoices](/docs/entities/invoices/list) — `GET /v1/invoices`
- [Create invoice](/docs/entities/invoices/create) — `POST /v1/invoices`
- [Get invoice](/docs/entities/invoices/get) — `GET /v1/invoices/*`
- [Update invoice](/docs/entities/invoices/update) — `PATCH /v1/invoices/*`
- [Delete invoice](/docs/entities/invoices/delete) — `DELETE /v1/invoices/*`
- [Search invoices](/docs/entities/invoices/search) — `POST /v1/invoices/search`
- [Aggregate invoices](/docs/entities/invoices/aggregate) — `POST /v1/invoices/aggregate`
- [Invoice fields](/docs/entities/invoices/fields) — `GET /v1/invoices/fields`
- [Invoice product rows](/docs/entities/invoices/products-get) — `GET /v1/invoices/*/products`
- [Set invoice products](/docs/entities/invoices/products-set) — `PUT /v1/invoices/*/products`
- [Add a product to an invoice](/docs/entities/invoices/products-add) — `POST /v1/invoices/*/products`
- [Invoice product fields](/docs/entities/invoices/products-fields) — `GET /v1/invoices/*/products/fields`
- [Get a product from an invoice](/docs/entities/invoices/products-get-single) — `GET /v1/invoices/*/products/*`
- [Update an invoice product](/docs/entities/invoices/products-update) — `PATCH /v1/invoices/*/products/*`
- [Delete a product from an invoice](/docs/entities/invoices/products-delete) — `DELETE /v1/invoices/*/products/*`

### [Smart processes (Items)](/docs/entities/items) · `crm`

- [List smart process items](/docs/entities/items/list) — `GET /v1/items/*`
- [Create a smart process item](/docs/entities/items/create) — `POST /v1/items/*`
- [Get a smart process item](/docs/entities/items/get) — `GET /v1/items/*/*`
- [Update a smart process item](/docs/entities/items/update) — `PATCH /v1/items/*/*`
- [Delete item](/docs/entities/items/delete) — `DELETE /v1/items/*/*`
- [Search smart process items](/docs/entities/items/search) — `POST /v1/items/*/search`
- [Aggregate items](/docs/entities/items/aggregate) — `POST /v1/items/*/aggregate`
- [Smart process item fields](/docs/entities/items/fields) — `GET /v1/items/*/fields`
- [Item product rows](/docs/entities/items/products-get) — `GET /v1/items/*/*/products`
- [Set products of a smart process item](/docs/entities/items/products-set) — `PUT /v1/items/*/*/products`
- [Add a product to a smart process item](/docs/entities/items/products-add) — `POST /v1/items/*/*/products`
- [Item product fields](/docs/entities/items/products-fields) — `GET /v1/items/*/*/products/fields`
- [Get a product from an item](/docs/entities/items/products-get-single) — `GET /v1/items/*/*/products/*`
- [Update a product of an item](/docs/entities/items/products-update) — `PATCH /v1/items/*/*/products/*`
- [Delete a product from a smart process item](/docs/entities/items/products-delete) — `DELETE /v1/items/*/*/products/*`

### [Leads](/docs/entities/leads) · `crm`

- [List leads](/docs/entities/leads/list) — `GET /v1/leads`
- [Create lead](/docs/entities/leads/create) — `POST /v1/leads`
- [Get lead](/docs/entities/leads/get) — `GET /v1/leads/*`
- [Update lead](/docs/entities/leads/update) — `PATCH /v1/leads/*`
- [Delete lead](/docs/entities/leads/delete) — `DELETE /v1/leads/*`
- [Search leads](/docs/entities/leads/search) — `POST /v1/leads/search`
- [Aggregate leads](/docs/entities/leads/aggregate) — `POST /v1/leads/aggregate`
- [Lead fields](/docs/entities/leads/fields) — `GET /v1/leads/fields`
- [List lead contacts](/docs/entities/leads/contacts-list) — `GET /v1/leads/*/contacts`
- [Link a contact to a lead](/docs/entities/leads/contacts-create) — `POST /v1/leads/*/contacts`
- [Replace lead contacts](/docs/entities/leads/contacts-set) — `PUT /v1/leads/*/contacts`
- [Unlink all contacts from a lead](/docs/entities/leads/contacts-delete) — `DELETE /v1/leads/*/contacts`
- [Unlink a contact from a lead](/docs/entities/leads/contacts-delete-delete) — `DELETE /v1/leads/*/contacts/*`
- [Lead product rows](/docs/entities/leads/products-get) — `GET /v1/leads/*/products`
- [Set lead products](/docs/entities/leads/products-set) — `PUT /v1/leads/*/products`
- [Add a product to a lead](/docs/entities/leads/products-add) — `POST /v1/leads/*/products`
- [Lead product fields](/docs/entities/leads/products-fields) — `GET /v1/leads/*/products/fields`
- [Get a product from a lead](/docs/entities/leads/products-get-single) — `GET /v1/leads/*/products/*`
- [Update a lead product](/docs/entities/leads/products-update) — `PATCH /v1/leads/*/products/*`
- [Delete a product from a lead](/docs/entities/leads/products-delete) — `DELETE /v1/leads/*/products/*`
- [Move lead to another status](/docs/entities/leads/move) — `POST /v1/leads/*/move`
- [Convert lead](/docs/entities/leads/convert) — `POST /v1/leads/*/convert`

### [Product sections](/docs/entities/product-sections) · `crm`

- [List sections](/docs/entities/product-sections/list) — `GET /v1/product-sections`
- [Create section](/docs/entities/product-sections/create) — `POST /v1/product-sections`
- [Get section](/docs/entities/product-sections/get) — `GET /v1/product-sections/*`
- [Update section](/docs/entities/product-sections/update) — `PATCH /v1/product-sections/*`
- [Delete section](/docs/entities/product-sections/delete) — `DELETE /v1/product-sections/*`
- [Search sections](/docs/entities/product-sections/search) — `POST /v1/product-sections/search`
- [Section fields](/docs/entities/product-sections/fields) — `GET /v1/product-sections/fields`

### [Products](/docs/entities/products) · `crm`

- [List CRM products](/docs/entities/products/list) — `GET /v1/products`
- [Create CRM product](/docs/entities/products/create) — `POST /v1/products`
- [Get CRM product](/docs/entities/products/get) — `GET /v1/products/*`
- [Update CRM product](/docs/entities/products/update) — `PATCH /v1/products/*`
- [Delete CRM product](/docs/entities/products/delete) — `DELETE /v1/products/*`
- [Search CRM products](/docs/entities/products/search) — `POST /v1/products/search`
- [Aggregate CRM products](/docs/entities/products/aggregate) — `POST /v1/products/aggregate`
- [CRM product fields](/docs/entities/products/fields) — `GET /v1/products/fields`

### [Quotes](/docs/entities/quotes) · `crm`

- [List quotes](/docs/entities/quotes/list) — `GET /v1/quotes`
- [Create a quote](/docs/entities/quotes/create) — `POST /v1/quotes`
- [Get a quote](/docs/entities/quotes/get) — `GET /v1/quotes/*`
- [Update a quote](/docs/entities/quotes/update) — `PATCH /v1/quotes/*`
- [Delete a quote](/docs/entities/quotes/delete) — `DELETE /v1/quotes/*`
- [Search quotes](/docs/entities/quotes/search) — `POST /v1/quotes/search`
- [Aggregate quotes](/docs/entities/quotes/aggregate) — `POST /v1/quotes/aggregate`
- [Quote fields](/docs/entities/quotes/fields) — `GET /v1/quotes/fields`
- [Quote product rows](/docs/entities/quotes/products-get) — `GET /v1/quotes/*/products`
- [Set quote products](/docs/entities/quotes/products-set) — `PUT /v1/quotes/*/products`
- [Add a product to a quote](/docs/entities/quotes/products-add) — `POST /v1/quotes/*/products`
- [Quote product fields](/docs/entities/quotes/products-fields) — `GET /v1/quotes/*/products/fields`
- [Get a product from a quote](/docs/entities/quotes/products-get-single) — `GET /v1/quotes/*/products/*`
- [Update a quote product](/docs/entities/quotes/products-update) — `PATCH /v1/quotes/*/products/*`
- [Delete a product from a quote](/docs/entities/quotes/products-delete) — `DELETE /v1/quotes/*/products/*`

### [Recurring deals](/docs/entities/recurring-deals) · `crm`

- [List recurring deals](/docs/entities/recurring-deals/list) — `GET /v1/recurring-deals`
- [Create recurring settings](/docs/entities/recurring-deals/create) — `POST /v1/recurring-deals`
- [Get recurring settings](/docs/entities/recurring-deals/get) — `GET /v1/recurring-deals/*`
- [Update recurring settings](/docs/entities/recurring-deals/update) — `PATCH /v1/recurring-deals/*`
- [Delete recurring settings](/docs/entities/recurring-deals/delete) — `DELETE /v1/recurring-deals/*`
- [Search recurring deals](/docs/entities/recurring-deals/search) — `POST /v1/recurring-deals/search`
- [Batch operations](/docs/entities/recurring-deals/batch) — `POST /v1/recurring-deals/batch`
- [Aggregate](/docs/entities/recurring-deals/aggregate) — `POST /v1/recurring-deals/aggregate`
- [Recurring deal fields](/docs/entities/recurring-deals/fields) — `GET /v1/recurring-deals/fields`
- [Create a deal from a template](/docs/entities/recurring-deals/expose) — `POST /v1/recurring-deals/*/expose`

### [Requisite links](/docs/entities/requisite-links) · `crm`

- [List requisite links](/docs/entities/requisite-links/list) — `GET /v1/requisite-links`
- [Register a requisite link](/docs/entities/requisite-links/register) — `POST /v1/requisite-links`
- [Requisite link fields](/docs/entities/requisite-links/fields) — `GET /v1/requisite-links/fields`
- [Search requisite links](/docs/entities/requisite-links/search) — `POST /v1/requisite-links/search`
- [Get a requisite link](/docs/entities/requisite-links/get) — `GET /v1/requisite-links/*/*`
- [Update a requisite link](/docs/entities/requisite-links/update) — `PATCH /v1/requisite-links/*/*`
- [Delete a requisite link](/docs/entities/requisite-links/unregister) — `DELETE /v1/requisite-links/*/*`

### [Requisite presets](/docs/entities/requisite-presets) · `crm`

- [List requisite presets](/docs/entities/requisite-presets/list) — `GET /v1/requisite-presets`
- [Create requisite preset](/docs/entities/requisite-presets/create) — `POST /v1/requisite-presets`
- [Get requisite preset](/docs/entities/requisite-presets/get) — `GET /v1/requisite-presets/*`
- [Update requisite preset](/docs/entities/requisite-presets/update) — `PATCH /v1/requisite-presets/*`
- [Delete requisite preset](/docs/entities/requisite-presets/delete) — `DELETE /v1/requisite-presets/*`
- [Search requisite presets](/docs/entities/requisite-presets/search) — `POST /v1/requisite-presets/search`
- [Requisite preset fields](/docs/entities/requisite-presets/fields) — `GET /v1/requisite-presets/fields`
- [Requisite preset fields](/docs/entities/requisite-presets/preset-fields) — subsection overview
- [List preset fields](/docs/entities/requisite-presets/preset-fields/list) — `GET /v1/requisite-presets/*/fields`
- [Add a field to a preset](/docs/entities/requisite-presets/preset-fields/create) — `POST /v1/requisite-presets/*/fields`
- [Preset field schema](/docs/entities/requisite-presets/preset-fields/schema) — `GET /v1/requisite-presets/*/fields/schema`
- [Fields available to add](/docs/entities/requisite-presets/preset-fields/available) — `GET /v1/requisite-presets/*/fields/available`
- [Get a preset field](/docs/entities/requisite-presets/preset-fields/get) — `GET /v1/requisite-presets/*/fields/*`
- [Update a preset field](/docs/entities/requisite-presets/preset-fields/update) — `PATCH /v1/requisite-presets/*/fields/*`
- [Delete a preset field](/docs/entities/requisite-presets/preset-fields/delete) — `DELETE /v1/requisite-presets/*/fields/*`
- [Requisite preset countries](/docs/entities/requisite-presets/countries) — `GET /v1/requisite-presets/countries`

### [Requisites](/docs/entities/requisites) · `crm`

- [List requisites](/docs/entities/requisites/list) — `GET /v1/requisites`
- [Create requisite](/docs/entities/requisites/create) — `POST /v1/requisites`
- [Get requisite](/docs/entities/requisites/get) — `GET /v1/requisites/*`
- [Update requisite](/docs/entities/requisites/update) — `PATCH /v1/requisites/*`
- [Delete requisite](/docs/entities/requisites/delete) — `DELETE /v1/requisites/*`
- [Search requisites](/docs/entities/requisites/search) — `POST /v1/requisites/search`
- [Aggregate requisites](/docs/entities/requisites/aggregate) — `POST /v1/requisites/aggregate`
- [Requisite fields](/docs/entities/requisites/fields) — `GET /v1/requisites/fields`
- [Look up requisites by number](/docs/entities/requisites/lookup) — `POST /v1/requisites/lookup`

### [Smart process types](/docs/entities/smart-processes) · `crm`

- [List smart process types](/docs/entities/smart-processes/list) — `GET /v1/smart-processes`
- [Create a smart process type](/docs/entities/smart-processes/create) — `POST /v1/smart-processes`
- [Get a smart process type](/docs/entities/smart-processes/get) — `GET /v1/smart-processes/*`
- [Update a smart process type](/docs/entities/smart-processes/update) — `PATCH /v1/smart-processes/*`
- [Delete a smart process type](/docs/entities/smart-processes/delete) — `DELETE /v1/smart-processes/*`
- [Search smart process types](/docs/entities/smart-processes/search) — `POST /v1/smart-processes/search`
- [Aggregating smart process types](/docs/entities/smart-processes/aggregate) — `POST /v1/smart-processes/aggregate`
- [Smart process type fields](/docs/entities/smart-processes/fields) — `GET /v1/smart-processes/fields`

### [CRM dictionaries](/docs/entities/statuses) · `crm`

- [List of dictionaries](/docs/entities/statuses/list) — `GET /v1/statuses`
- [Create dictionary record](/docs/entities/statuses/create) — `POST /v1/statuses`
- [Get dictionary record](/docs/entities/statuses/get) — `GET /v1/statuses/*`
- [Update dictionary record](/docs/entities/statuses/update) — `PATCH /v1/statuses/*`
- [Delete dictionary record](/docs/entities/statuses/delete) — `DELETE /v1/statuses/*`
- [Search dictionary records](/docs/entities/statuses/search) — `POST /v1/statuses/search`
- [Aggregate dictionary records](/docs/entities/statuses/aggregate) — `POST /v1/statuses/aggregate`
- [Dictionary fields](/docs/entities/statuses/fields) — `GET /v1/statuses/fields`
- [Status dictionary types](/docs/entities/statuses/entity-types) — `GET /v1/statuses/entity-types`

### [Timeline comments](/docs/entities/timelines) · `crm`

- [List comments](/docs/entities/timelines/list) — `GET /v1/timelines`
- [Add comment](/docs/entities/timelines/create) — `POST /v1/timelines`
- [Get comment](/docs/entities/timelines/get) — `GET /v1/timelines/*`
- [Update comment](/docs/entities/timelines/update) — `PATCH /v1/timelines/*`
- [Delete comment](/docs/entities/timelines/delete) — `DELETE /v1/timelines/*`
- [Search comments](/docs/entities/timelines/search) — `POST /v1/timelines/search`
- [Comment fields](/docs/entities/timelines/fields) — `GET /v1/timelines/fields`
- [Download a timeline comment attachment](/docs/entities/timelines/file-download) — `GET /v1/timelines/*/files/*/download`
- [Timeline comments](/docs/entities/timelines) — 8 operations

### [CRM import](/docs/import) · `crm`

- [Importing CRM records](/docs/import) — 7 operations

### [CRM field files](/docs/recipes/crm-files) · `crm`

- [Working with files in CRM fields](/docs/recipes/crm-files) — 7 operations

### [Stage history](/docs/stage-history) · `crm`

- [Stage history](/docs/stage-history) — `GET /v1/stage-history`

### [CRM Timeline](/docs/timeline-logs) · `crm`

- [Timeline entries](/docs/timeline-logs/logs) — subsection overview
- [Create an entry](/docs/timeline-logs/logs/create) — `POST /v1/timeline-logs`
- [List entries](/docs/timeline-logs/logs/list) — `GET /v1/timeline-logs`
- [Get an entry](/docs/timeline-logs/logs/get) — `GET /v1/timeline-logs/*`
- [Delete an entry](/docs/timeline-logs/logs/delete) — `DELETE /v1/timeline-logs/*`
- [Notes](/docs/timeline-logs/notes) — subsection overview
- [Save note](/docs/timeline-logs/notes/save) — `POST /v1/timeline-logs/*/note`
- [Get note](/docs/timeline-logs/notes/get) — `GET /v1/timeline-logs/*/note`
- [Delete note](/docs/timeline-logs/notes/delete) — `DELETE /v1/timeline-logs/*/note`
- [Pins](/docs/timeline-logs/pins) — subsection overview
- [Pin an entry](/docs/timeline-logs/pins/pin) — `POST /v1/timeline-logs/*/pin`
- [Unpin an entry](/docs/timeline-logs/pins/unpin) — `POST /v1/timeline-logs/*/unpin`
- [Bindings](/docs/timeline-logs/bindings) — subsection overview
- [Bind an entry](/docs/timeline-logs/bindings/bind) — `POST /v1/timeline-logs/*/bind`
- [Unbind](/docs/timeline-logs/bindings/unbind) — `POST /v1/timeline-logs/*/unbind`
- [List bindings](/docs/timeline-logs/bindings/list) — `GET /v1/timeline-logs/*/bindings`

### [Custom Fields](/docs/userfields) · `crm` `task` `user.userfield`

- [CRM entity fields](/docs/userfields/crm) — subsection overview
- [List entity fields](/docs/userfields/crm/list) — `GET /v1/userfields/*`
- [Create field](/docs/userfields/crm/create) — `POST /v1/userfields/*`
- [Field type catalog](/docs/userfields/crm/types) — `GET /v1/userfields/*/types`
- [Get field](/docs/userfields/crm/get) — `GET /v1/userfields/*/*`
- [Update field](/docs/userfields/crm/update) — `PATCH /v1/userfields/*/*`
- [Delete field](/docs/userfields/crm/delete) — `DELETE /v1/userfields/*/*`
- [Module custom-field types](/docs/userfields/types) — `GET /v1/userfields/types`
- [Smart process fields](/docs/userfields/smart-processes) — subsection overview
- [List smart process fields](/docs/userfields/smart-processes/list) — `GET /v1/items/*/userfields` `GET /v1/userfields/invoices`
- [Create field](/docs/userfields/smart-processes/create) — `POST /v1/items/*/userfields` `POST /v1/userfields/invoices`
- [Field type catalog](/docs/userfields/smart-processes/types) — `GET /v1/items/*/userfields/types` `GET /v1/userfields/invoices/types`
- [Get field](/docs/userfields/smart-processes/get) — `GET /v1/items/*/userfields/*` `GET /v1/userfields/invoices/*`
- [Update field](/docs/userfields/smart-processes/update) — `PATCH /v1/items/*/userfields/*` `PATCH /v1/userfields/invoices/*`
- [Delete field](/docs/userfields/smart-processes/delete) — `DELETE /v1/items/*/userfields/*` `DELETE /v1/userfields/invoices/*`
- [Task fields](/docs/userfields/tasks) — subsection overview
- [List fields](/docs/userfields/tasks/list) — `GET /v1/userfields/tasks`
- [Create field](/docs/userfields/tasks/create) — `POST /v1/userfields/tasks`
- [Field types](/docs/userfields/tasks/types) — `GET /v1/userfields/tasks/types`
- [Get field](/docs/userfields/tasks/get) — `GET /v1/userfields/tasks/*`
- [Update field](/docs/userfields/tasks/update) — `PATCH /v1/userfields/tasks/*`
- [Delete field](/docs/userfields/tasks/delete) — `DELETE /v1/userfields/tasks/*`
- [Employee fields](/docs/userfields/users) — subsection overview
- [List employee fields](/docs/userfields/users/list) — `GET /v1/userfields/users`
- [Create employee field](/docs/userfields/users/create) — `POST /v1/userfields/users`
- [Get employee field](/docs/userfields/users/get) — `GET /v1/userfields/users/*`
- [Update employee field](/docs/userfields/users/update) — `PATCH /v1/userfields/users/*`
- [Delete employee field](/docs/userfields/users/delete) — `DELETE /v1/userfields/users/*`

## Tasks & calendar

### [Calendar](/docs/calendar) · `calendar`

- [Calendar settings](/docs/calendar/settings) — `GET /v1/calendar/settings`
- [Attendee availability](/docs/calendar/accessibility) — `GET /v1/calendar/accessibility`

### [Client types](/docs/entities/booking-client-types) · `booking`

- [List booking client types](/docs/entities/booking-client-types/list) — `GET /v1/booking-client-types`

### [Booking resource types](/docs/entities/booking-resource-types) · `booking`

- [Get: Booking resource types](/docs/entities/booking-resource-types/get) — `GET /v1/booking-resource-types/*`
- [Update: Booking resource types](/docs/entities/booking-resource-types/update) — `PATCH /v1/booking-resource-types/*`
- [Delete: Booking resource types](/docs/entities/booking-resource-types/delete) — `DELETE /v1/booking-resource-types/*`
- [Create: Booking resource types](/docs/entities/booking-resource-types/create) — `POST /v1/booking-resource-types`
- [List: Booking resource types](/docs/entities/booking-resource-types/list) — `GET /v1/booking-resource-types`

### [Booking resources](/docs/entities/booking-resources) · `booking`

- [List booking resources](/docs/entities/booking-resources/list) — `GET /v1/booking-resources`
- [Create: Booking resources](/docs/entities/booking-resources/create) — `POST /v1/booking-resources`
- [Get: Booking resources](/docs/entities/booking-resources/get) — `GET /v1/booking-resources/*`
- [Update: Booking resources](/docs/entities/booking-resources/update) — `PATCH /v1/booking-resources/*`
- [Delete: Booking resources](/docs/entities/booking-resources/delete) — `DELETE /v1/booking-resources/*`
- [Get resource work hours](/docs/entities/booking-resources/slots-list) — `GET /v1/booking-resources/*/slots`
- [Set resource work hours](/docs/entities/booking-resources/slots-set) — `PUT /v1/booking-resources/*/slots`
- [Remove resource work hours](/docs/entities/booking-resources/slots-delete) — `DELETE /v1/booking-resources/*/slots`

### [Booking wait list](/docs/entities/booking-wait-list) · `booking`

- [List clients of a wait list record](/docs/entities/booking-wait-list/clients-list) — `GET /v1/booking-wait-list/*/clients`
- [Replace clients of a wait list record](/docs/entities/booking-wait-list/clients-set) — `PUT /v1/booking-wait-list/*/clients`
- [Remove clients from a wait list record](/docs/entities/booking-wait-list/clients-delete) — `DELETE /v1/booking-wait-list/*/clients`
- [List booking wait list records](/docs/entities/booking-wait-list/list) — `GET /v1/booking-wait-list`
- [Create an entry](/docs/entities/booking-wait-list/create) — `POST /v1/booking-wait-list`
- [Get an entry](/docs/entities/booking-wait-list/get) — `GET /v1/booking-wait-list/*`
- [Update an entry](/docs/entities/booking-wait-list/update) — `PATCH /v1/booking-wait-list/*`
- [Delete an entry](/docs/entities/booking-wait-list/delete) — `DELETE /v1/booking-wait-list/*`
- [Book from the wait list](/docs/entities/booking-wait-list/booking) — `POST /v1/booking-wait-list/*/booking`

### [Bookings](/docs/entities/bookings) · `booking`

- [Create a booking](/docs/entities/bookings/create) — `POST /v1/bookings`
- [List bookings](/docs/entities/bookings/list) — `GET /v1/bookings`
- [Get a booking](/docs/entities/bookings/get) — `GET /v1/bookings/*`
- [Update a booking](/docs/entities/bookings/update) — `PATCH /v1/bookings/*`
- [Delete a booking](/docs/entities/bookings/delete) — `DELETE /v1/bookings/*`
- [Booking fields](/docs/entities/bookings/fields) — `GET /v1/bookings/fields`
- [Search bookings](/docs/entities/bookings/search) — `POST /v1/bookings/search`
- [List booking clients](/docs/entities/bookings/clients-list) — `GET /v1/bookings/*/clients`
- [Replace booking clients](/docs/entities/bookings/clients-set) — `PUT /v1/bookings/*/clients`
- [Remove booking clients](/docs/entities/bookings/clients-delete) — `DELETE /v1/bookings/*/clients`
- [Move a booking to the wait list](/docs/entities/bookings/wait-list) — `POST /v1/bookings/*/wait-list`

### [Calendar events](/docs/entities/calendar-events) · `calendar`

- [List events](/docs/entities/calendar-events/list) — `GET /v1/calendar-events`
- [Create event](/docs/entities/calendar-events/create) — `POST /v1/calendar-events`
- [Get event](/docs/entities/calendar-events/get) — `GET /v1/calendar-events/*`
- [Update event](/docs/entities/calendar-events/update) — `PATCH /v1/calendar-events/*`
- [Delete event](/docs/entities/calendar-events/delete) — `DELETE /v1/calendar-events/*`
- [Calendar event search](/docs/entities/calendar-events/search) — `POST /v1/calendar-events/search`
- [Aggregate calendar events](/docs/entities/calendar-events/aggregate) — `POST /v1/calendar-events/aggregate`
- [Event fields](/docs/entities/calendar-events/fields) — `GET /v1/calendar-events/fields`
- [Get meeting participation status](/docs/entities/calendar-events/meeting-status-list) — `GET /v1/calendar-events/*/meeting-status`
- [Change meeting participation status](/docs/entities/calendar-events/meeting-status-set) — `PUT /v1/calendar-events/*/meeting-status`

### [Calendar resources](/docs/entities/calendar-resources) · `calendar`

- [List calendar resources](/docs/entities/calendar-resources/list) — `GET /v1/calendar-resources`
- [Create calendar resource](/docs/entities/calendar-resources/create) — `POST /v1/calendar-resources`
- [Calendar resource fields](/docs/entities/calendar-resources/fields) — `GET /v1/calendar-resources/fields`
- [Resource bookings](/docs/entities/calendar-resources/bookings) — `GET /v1/calendar-resources/bookings`
- [Rename calendar resource](/docs/entities/calendar-resources/update) — `PATCH /v1/calendar-resources/*`
- [Delete calendar resource](/docs/entities/calendar-resources/delete) — `DELETE /v1/calendar-resources/*`

### [Calendar sections](/docs/entities/calendar-sections) · `calendar`

- [List sections](/docs/entities/calendar-sections/list) — `GET /v1/calendar-sections`
- [Create a section](/docs/entities/calendar-sections/create) — `POST /v1/calendar-sections`
- [Update section](/docs/entities/calendar-sections/update) — `PATCH /v1/calendar-sections/*`
- [Delete a section](/docs/entities/calendar-sections/delete) — `DELETE /v1/calendar-sections/*`
- [Calendar section search](/docs/entities/calendar-sections/search) — `POST /v1/calendar-sections/search`
- [Batch operations on calendar sections](/docs/entities/calendar-sections/batch) — `POST /v1/calendar-sections/batch`
- [Calendar section fields](/docs/entities/calendar-sections/fields) — `GET /v1/calendar-sections/fields`

### [Task comments](/docs/entities/task-comments) · `task` `tasks`

- [List comments](/docs/entities/task-comments/list) — `GET /v1/tasks/*/comments`
- [Create comment](/docs/entities/task-comments/create) — `POST /v1/tasks/*/comments`
- [Comment fields](/docs/entities/task-comments/fields) — `GET /v1/tasks/*/comments/fields`
- [Get comment](/docs/entities/task-comments/get) — `GET /v1/tasks/*/comments/*`
- [Update comment](/docs/entities/task-comments/update) — `PATCH /v1/tasks/*/comments/*`
- [Delete comment](/docs/entities/task-comments/delete) — `DELETE /v1/tasks/*/comments/*`
- [Download a task comment attachment](/docs/entities/task-comments/file-download) — `GET /v1/tasks/*/comments/*/files/*/download`
- [Batch comment operations](/docs/entities/task-comments/comments-batch) — `POST /v1/tasks/*/comments/batch`

### [Tasks](/docs/entities/tasks) · `task` `tasks`

- [List tasks](/docs/entities/tasks/list) — `GET /v1/tasks`
- [Create task](/docs/entities/tasks/create) — `POST /v1/tasks`
- [Get task](/docs/entities/tasks/get) — `GET /v1/tasks/*`
- [Update task](/docs/entities/tasks/update) — `PATCH /v1/tasks/*`
- [Delete task](/docs/entities/tasks/delete) — `DELETE /v1/tasks/*`
- [Search tasks](/docs/entities/tasks/search) — `POST /v1/tasks/search`
- [Aggregate tasks](/docs/entities/tasks/aggregate) — `POST /v1/tasks/aggregate`
- [Task fields](/docs/entities/tasks/fields) — `GET /v1/tasks/fields`
- [Task time tracking](/docs/entities/tasks/time) — subsection overview
- [List time-tracking entries](/docs/entities/tasks/time/list) — `GET /v1/tasks/*/time`
- [Add a time-tracking entry](/docs/entities/tasks/time/create) — `POST /v1/tasks/*/time`
- [Get a time-tracking entry](/docs/entities/tasks/time/get) — `GET /v1/tasks/*/time/*`
- [Update a time-tracking entry](/docs/entities/tasks/time/update) — `PATCH /v1/tasks/*/time/*`
- [Delete a time-tracking entry](/docs/entities/tasks/time/delete) — `DELETE /v1/tasks/*/time/*`
- [Task checklist](/docs/entities/tasks/checklist) — subsection overview
- [List checklist items](/docs/entities/tasks/checklist/list) — `GET /v1/tasks/*/checklist`
- [Add a checklist item](/docs/entities/tasks/checklist/create) — `POST /v1/tasks/*/checklist`
- [Get a checklist item](/docs/entities/tasks/checklist/get) — `GET /v1/tasks/*/checklist/*`
- [Update a checklist item](/docs/entities/tasks/checklist/update) — `PATCH /v1/tasks/*/checklist/*`
- [Delete a checklist item](/docs/entities/tasks/checklist/delete) — `DELETE /v1/tasks/*/checklist/*`
- [Mark an item complete](/docs/entities/tasks/checklist/complete) — `POST /v1/tasks/*/checklist/*/complete`
- [Reopen an item](/docs/entities/tasks/checklist/renew) — `POST /v1/tasks/*/checklist/*/renew`
- [Add a task result](/docs/entities/tasks/results-v3-create) — `POST /v1/task-results`
- [Create a task result from a chat message](/docs/entities/tasks/results-v3-from-chat-message) — `POST /v1/task-results/from-chat-message`
- [Update a task result](/docs/entities/tasks/results-v3-update) — `PATCH /v1/task-results/*`
- [Delete a task result](/docs/entities/tasks/results-v3-delete) — `DELETE /v1/task-results/*`
- [Save a task checklist](/docs/entities/tasks/checklist-actions/tree) — `POST /v1/tasks/*/checklist/tree`
- [Mark an item complete with its sub-items](/docs/entities/tasks/checklist-actions/complete-all) — `POST /v1/tasks/*/checklist/*/complete-all`
- [Move an item before another](/docs/entities/tasks/checklist-actions/move-before) — `POST /v1/tasks/*/checklist/*/move-before`
- [Move an item after another](/docs/entities/tasks/checklist-actions/move-after) — `POST /v1/tasks/*/checklist/*/move-after`
- [Add checklist item members](/docs/entities/tasks/checklist-actions/members) — `POST /v1/tasks/*/checklist/*/members`
- [Checklist actions and task file](/docs/entities/tasks/checklist-actions) — `POST /v1/tasks/*/checklist/*/members/remove`
- [Attach a file to a checklist item by content](/docs/entities/tasks/checklist-actions/attachments-content) — `POST /v1/tasks/*/checklist/*/attachments/content`
- [Attach Drive files to a checklist item](/docs/entities/tasks/checklist-actions/attachments-disk) — `POST /v1/tasks/*/checklist/*/attachments/disk`
- [Remove checklist item attachments](/docs/entities/tasks/checklist-actions/attachments-remove) — `POST /v1/tasks/*/checklist/*/attachments/remove`
- [Attach a file to a task](/docs/entities/tasks/files-attach) — `POST /v1/tasks/*/files/attach`
- [Dependencies of one task](/docs/entities/tasks/dependencies-list) — `GET /v1/tasks/*/dependencies`
- [Dependencies of several tasks](/docs/entities/tasks/dependencies-bulk) — `POST /v1/tasks/dependencies/bulk`
- [Add a task to favorites](/docs/entities/tasks/favorite) — `POST /v1/tasks/*/favorite`
- [Remove a task from favorites](/docs/entities/tasks/unfavorite) — `DELETE /v1/tasks/*/favorite`
- [Pin a task](/docs/entities/tasks/pin) — `POST /v1/tasks/*/pin`
- [Unpin a task](/docs/entities/tasks/unpin) — `DELETE /v1/tasks/*/pin`
- [List flows](/docs/entities/tasks/flows-list) — `GET /v1/tasks/flows`
- [Create a flow](/docs/entities/tasks/flows-create) — `POST /v1/tasks/flows`
- [Get a flow](/docs/entities/tasks/flows-get) — `GET /v1/tasks/flows/*`
- [Update a flow](/docs/entities/tasks/flows-update) — `PATCH /v1/tasks/flows/*`
- [Delete a flow](/docs/entities/tasks/flows-delete) — `DELETE /v1/tasks/flows/*`
- [Toggle flow activity](/docs/entities/tasks/flows-activate) — `POST /v1/tasks/flows/*/activate`
- [List completed flow tasks](/docs/entities/tasks/flows-completed) — `GET /v1/tasks/flows/*/tasks/completed`
- [List pending flow tasks](/docs/entities/tasks/flows-pending) — `GET /v1/tasks/flows/*/tasks/pending`
- [List in-progress flow tasks](/docs/entities/tasks/flows-progress) — `GET /v1/tasks/flows/*/tasks/progress`
- [Add task accomplices](/docs/entities/tasks/add-accomplices) — `POST /v1/tasks/*/add-accomplices`
- [Add task auditors](/docs/entities/tasks/add-auditors) — `POST /v1/tasks/*/add-auditors`
- [Approve task](/docs/entities/tasks/approve) — `POST /v1/tasks/*/approve`
- [Bind CRM item to task](/docs/entities/tasks/bind-crm-item) — `POST /v1/tasks/*/bind-crm-item`
- [Complete task](/docs/entities/tasks/complete) — `POST /v1/tasks/*/complete`
- [Defer task](/docs/entities/tasks/defer) — `POST /v1/tasks/*/defer`
- [Delegate task](/docs/entities/tasks/delegate) — `POST /v1/tasks/*/delegate`
- [Disapprove task](/docs/entities/tasks/disapprove) — `POST /v1/tasks/*/disapprove`
- [Pause task](/docs/entities/tasks/pause) — `POST /v1/tasks/*/pause`
- [Pause task timer](/docs/entities/tasks/pause-timer) — `POST /v1/tasks/*/pause-timer`
- [Renew task](/docs/entities/tasks/renew) — `POST /v1/tasks/*/renew`
- [Start task](/docs/entities/tasks/start) — `POST /v1/tasks/*/start`
- [Start task timer](/docs/entities/tasks/start-timer) — `POST /v1/tasks/*/start-timer`
- [Take task](/docs/entities/tasks/take) — `POST /v1/tasks/*/take`
- [List task templates](/docs/entities/tasks/templates-list) — `GET /v1/task-templates`
- [Create a task template](/docs/entities/tasks/templates-create) — `POST /v1/task-templates`
- [Get a task template](/docs/entities/tasks/templates-get) — `GET /v1/task-templates/*`
- [Update a task template](/docs/entities/tasks/templates-update) — `PATCH /v1/task-templates/*`
- [Create a task result from a comment](/docs/entities/tasks/results-from-comment) — `POST /v1/task-results/from-comment/*`
- [Task results: legacy REST](/docs/entities/tasks/results) — `GET /v1/tasks/*/results`
- [Get the ID of the first task result](/docs/entities/tasks/results-first) — `GET /v1/tasks/*/results/first`
- [Get the ID of the last task result](/docs/entities/tasks/results-last) — `GET /v1/tasks/*/results/last`
- [Task chat](/docs/entities/tasks/chat) — `GET /v1/tasks/*/chat/messages`
- [List entries across the whole Bitrix24 account](/docs/entities/tasks/time/global-list) — `GET /v1/task-time`
- [Time-tracking entry fields](/docs/entities/tasks/time/fields) — `GET /v1/task-time/fields`

### [Scrum: Epics & Tasks](/docs/scrum) · `task`

- [Scrum Definition of Done](/docs/scrum/dod) — `GET /v1/scrum/groups/*/dod/settings` `GET /v1/scrum/groups/*/tasks/*/dod/necessary` `POST /v1/scrum/groups/*/dod/types/*/settings` `POST /v1/scrum/tasks/*/dod/*`
- [Sprint metrics](/docs/scrum/metrics) — `GET /v1/scrum/groups/*/burn-down` `GET /v1/scrum/groups/*/team-speed`
- [List sprints](/docs/scrum/sprints/list) — `GET /v1/scrum/sprints`
- [Create a sprint](/docs/scrum/sprints/create) — `POST /v1/scrum/sprints`
- [Active sprint](/docs/scrum/sprints/active) — `GET /v1/scrum/sprints/active`
- [Get a sprint](/docs/scrum/sprints/get) — `GET /v1/scrum/sprints/*`
- [Update a sprint](/docs/scrum/sprints/update) — `PATCH /v1/scrum/sprints/*`
- [Delete a sprint](/docs/scrum/sprints/delete) — `DELETE /v1/scrum/sprints/*`
- [List stages](/docs/scrum/stages/list) — `GET /v1/scrum/sprints/*/stages`
- [Create a stage](/docs/scrum/stages/create) — `POST /v1/scrum/sprints/*/stages`
- [Update a stage](/docs/scrum/stages/update) — `PATCH /v1/scrum/stages/*`
- [Scrum kanban stages](/docs/scrum/stages) — `DELETE /v1/scrum/stages/*` `POST /v1/scrum/sprints/*/kanban/tasks/*` `DELETE /v1/scrum/sprints/*/kanban/tasks/*`
- [List epics](/docs/scrum/epics/list) — `GET /v1/scrum/epics`
- [Create an epic](/docs/scrum/epics/create) — `POST /v1/scrum/epics`
- [Get an epic](/docs/scrum/epics/get) — `GET /v1/scrum/epics/*`
- [Update an epic](/docs/scrum/epics/update) — `PATCH /v1/scrum/epics/*`
- [Scrum epics](/docs/scrum/epics) — `DELETE /v1/scrum/epics/*`
- [Task placement in scrum](/docs/scrum/tasks) — subsection overview
- [Get a task's scrum placement](/docs/scrum/tasks/get) — `GET /v1/scrum/tasks/*`
- [Place or move a task in scrum](/docs/scrum/tasks/update) — `PATCH /v1/scrum/tasks/*`
- [Scrum backlogs](/docs/scrum/backlogs) — subsection overview
- [Create a backlog](/docs/scrum/backlogs/create) — `POST /v1/scrum/backlogs`
- [Update a backlog](/docs/scrum/backlogs/update) — `PATCH /v1/scrum/backlogs/*`
- [Delete a backlog](/docs/scrum/backlogs/delete) — `DELETE /v1/scrum/backlogs/*`
- [Sprints](/docs/scrum/sprints) — `POST /v1/scrum/sprints/*/start`
- [Complete the active sprint](/docs/scrum/sprints/complete) — `POST /v1/scrum/groups/*/sprints/active/complete`

### [Task change history](/docs/task-history) · `task`

- [Task change history](/docs/task-history) — `GET /v1/tasks/*/history`

### [Task kanban stages](/docs/task-stages) · `task`

- [List task kanban stages](/docs/task-stages/list) — `GET /v1/tasks/stages/*`
- [Update a task stage](/docs/task-stages/update) — `PATCH /v1/task-stages/*`
- [Delete an empty task stage](/docs/task-stages/delete) — `DELETE /v1/task-stages/*`

### [Kanban, My Plan & day plan](/docs/tasks) · `task`

- [Create a task stage](/docs/tasks/stages) — `POST /v1/tasks/stages/*`
- [Move a task with ordering](/docs/tasks/move-stage) — `POST /v1/tasks/*/move-stage`
- [Read the kanban sorting permission](/docs/tasks/stages-can-move) — `GET /v1/tasks/stages/*/can-move`
- [Read the day plan](/docs/tasks/day-plan) — `GET /v1/tasks/day-plan`

## Communication

### [Bot Platform](/docs/bots) · `imbot` `imopenlines`

- [Bot management](/docs/bots/management) — subsection overview
- [Register a bot](/docs/bots/management/create) — `POST /v1/bots`
- [List bots](/docs/bots/management/list) — `GET /v1/bots`
- [Recover a bot registration](/docs/bots/management/registrations-recover) — `POST /v1/bots/registrations/*/recover`
- [Get a bot](/docs/bots/management/get) — `GET /v1/bots/*`
- [Update a bot](/docs/bots/management/update) — `PATCH /v1/bots/*`
- [Delete a bot](/docs/bots/management/delete) — `DELETE /v1/bots/*`
- [Bot platform revision](/docs/bots/management/revision) — `GET /v1/bots/revision`
- [Bot re-authorization](/docs/bots/management/reauth) — `POST /v1/bots/*/reauth`
- [Re-subscribe to events](/docs/bots/management/resubscribe) — `POST /v1/bots/*/resubscribe`
- [Events](/docs/bots/events) — subsection overview
- [Get events (polling)](/docs/bots/events/polling) — `GET /v1/bots/*/events`
- [Bot sessions in Open Channels](/docs/bots/openlines) — subsection overview
- [Hand to an operator](/docs/bots/openlines/operator) — `POST /v1/bots/*/openlines/session/operator`
- [Transfer a session](/docs/bots/openlines/transfer) — `POST /v1/bots/*/openlines/session/transfer`
- [Finish a session](/docs/bots/openlines/finish) — `POST /v1/bots/*/openlines/session/finish`
- [Send an automatic line message](/docs/bots/openlines/auto-message) — `POST /v1/bots/*/openlines/session/auto-message`
- [Messages](/docs/bots/messages) — subsection overview
- [Send message](/docs/bots/messages/send) — `POST /v1/bots/*/messages`
- [Get message](/docs/bots/messages/get) — `GET /v1/bots/*/messages/*`
- [Update message](/docs/bots/messages/update) — `PATCH /v1/bots/*/messages/*`
- [Delete message](/docs/bots/messages/delete) — `DELETE /v1/bots/*/messages/*`
- [Read messages](/docs/bots/messages/read) — `POST /v1/bots/*/chats/*/read`
- [Message context](/docs/bots/messages/context) — `GET /v1/bots/*/messages/*/context`
- [Interface](/docs/bots/ui) — subsection overview
- [Add reaction](/docs/bots/ui/reaction-add) — `POST /v1/bots/*/messages/*/reactions`
- [Remove reaction](/docs/bots/ui/reaction-delete) — `DELETE /v1/bots/*/messages/*/reactions`
- [Typing indicator](/docs/bots/ui/typing) — `POST /v1/bots/*/typing`
- [Input field control](/docs/bots/ui/text-field) — `POST /v1/bots/*/text-field`
- [Chats](/docs/bots/chats) — subsection overview
- [Create a chat](/docs/bots/chats/create) — `POST /v1/bots/*/chats`
- [Get a chat](/docs/bots/chats/get) — `GET /v1/bots/*/chats/*`
- [Update a chat](/docs/bots/chats/update) — `PATCH /v1/bots/*/chats/*`
- [Leave a chat](/docs/bots/chats/leave) — `POST /v1/bots/*/chats/*/leave`
- [Assign an owner](/docs/bots/chats/set-owner) — `POST /v1/bots/*/chats/*/owner`
- [Add participants](/docs/bots/chats/user-add) — `POST /v1/bots/*/chats/*/users`
- [List participants](/docs/bots/chats/user-list) — `GET /v1/bots/*/chats/*/users`
- [Remove a participant](/docs/bots/chats/user-delete) — `DELETE /v1/bots/*/chats/*/users`
- [Add managers](/docs/bots/chats/manager-add) — `POST /v1/bots/*/chats/*/managers`
- [Remove managers](/docs/bots/chats/manager-delete) — `DELETE /v1/bots/*/chats/*/managers`
- [Commands](/docs/bots/commands) — subsection overview
- [Register a command](/docs/bots/commands/register) — `POST /v1/bots/*/commands`
- [List commands](/docs/bots/commands/list) — `GET /v1/bots/*/commands`
- [Update a command](/docs/bots/commands/update) — `PATCH /v1/bots/*/commands/*`
- [Delete a command](/docs/bots/commands/delete) — `DELETE /v1/bots/*/commands/*`
- [Answer a command](/docs/bots/commands/answer) — `POST /v1/bots/*/commands/*/answer`
- [Files](/docs/bots/files) — subsection overview
- [Upload file](/docs/bots/files/upload) — `POST /v1/bots/*/files`
- [Download file](/docs/bots/files/download) — `GET /v1/bots/*/files/*`
- [Transfer bot ownership](/docs/bots/management/transfer) — `POST /v1/bots/*/transfer`

### [Calls](/docs/calls) · `call` `telephony`

- [Call follow-up](/docs/calls/followup) — subsection overview
- [Follow-up list](/docs/calls/followup/list) — `POST /v1/calls/followups/list`
- [Follow-up for a single call](/docs/calls/followup/get) — `GET /v1/calls/followups/*`
- [Call journal](/docs/calls/log) — subsection overview
- [List call journal](/docs/calls/log/list) — `GET /v1/calls/log`
- [Delete journal entry](/docs/calls/log/delete) — `DELETE /v1/calls/log/*`
- [Chat with a user](/docs/calls/log/chat) — `GET /v1/calls/log/chat`
- [CRM cards by phone](/docs/calls/crm-entities) — `GET /v1/calls/crm-entities`
- [Call recording](/docs/calls/record) — `POST /v1/calls/*/record`

### [Chats](/docs/chats) · `im`

- [Chat discovery](/docs/chats/discovery) — subsection overview
- [Recent dialogs](/docs/chats/discovery/recent) — `GET /v1/chats/recent`
- [Unread counters](/docs/chats/discovery/counters) — `GET /v1/chats/counters`
- [Messages](/docs/chats/messages) — subsection overview
- [Load a chat](/docs/chats/messages/load) — `GET /v1/chats/*/load`
- [Messages around a message](/docs/chats/messages/context) — `GET /v1/chats/messages/*/context`
- [Find a CRM entity chat](/docs/chats/discovery/find) — `GET /v1/chats/find`
- [Search chats by text](/docs/chats/discovery/search) — `GET /v1/chats/search`
- [Files](/docs/chats/files) — subsection overview
- [File metadata](/docs/chats/files/file-get) — `GET /v1/chats/files/*`
- [Dialog details](/docs/chats/discovery/get) — `GET /v1/chats/*`
- [Chat management](/docs/chats/management) — subsection overview
- [Delete a chat](/docs/chats/management/delete) — `DELETE /v1/chats/*`
- [Read messages](/docs/chats/messages/list) — `GET /v1/chats/*/messages`
- [Send a message](/docs/chats/messages/send) — `POST /v1/chats/*/messages`
- [Edit a message](/docs/chats/messages/update) — `PATCH /v1/chats/*/messages/*`
- [Delete a message](/docs/chats/messages/delete) — `DELETE /v1/chats/*/messages/*`
- [Create a group chat](/docs/chats/management/create) — `POST /v1/chats`
- [Rename a chat](/docs/chats/management/rename) — `PATCH /v1/chats/*`
- [Leave a chat](/docs/chats/management/leave) — `POST /v1/chats/*/leave`
- [Chat notifications](/docs/chats/management/mute) — `POST /v1/chats/*/mute`
- [Members](/docs/chats/members) — subsection overview
- [List members](/docs/chats/members/list) — `GET /v1/chats/*/users`
- [Add members](/docs/chats/members/add) — `POST /v1/chats/*/users`
- [Remove a member](/docs/chats/members/remove) — `DELETE /v1/chats/*/users`
- [Upload a file to a chat](/docs/chats/files/upload) — `POST /v1/chats/*/files`
- [Chat folder on Drive](/docs/chats/files/folder) — `GET /v1/chats/*/folder`
- [Mark as read](/docs/chats/messages/read) — `POST /v1/chats/*/read`
- [Bulk message load](/docs/chats/messages/bulk) — `POST /v1/chats/messages/bulk`
- [Events](/docs/chats/events) — subsection overview
- [Subscribe to events](/docs/chats/events/subscribe) — `POST /v1/chats/events/subscribe`
- [Unsubscribe from events](/docs/chats/events/unsubscribe) — `POST /v1/chats/events/unsubscribe`
- [Set the "unread" mark](/docs/chats/management/unread-create) — `POST /v1/chats/*/unread`
- [Clear the "unread" mark](/docs/chats/management/unread-delete) — `DELETE /v1/chats/*/unread`
- [Pin a chat](/docs/chats/management/pin) — `POST /v1/chats/*/pin`
- [Pinned chat order](/docs/chats/management/pin-sort) — `PUT /v1/chats/*/pin`
- [Unpin a chat](/docs/chats/management/unpin) — `DELETE /v1/chats/*/pin`
- [Read all chats](/docs/chats/management/read-all) — `POST /v1/chats/read-all`
- [Read a list section](/docs/chats/management/read-section) — `POST /v1/chats/recent/read`
- [Channel list](/docs/chats/discovery/recent-channels) — `GET /v1/chats/recent/channels`
- [Collab list](/docs/chats/discovery/recent-collabs) — `GET /v1/chats/recent/collabs`
- [Project chats](/docs/chats/discovery/project-recent) — `GET /v1/chats/projects/*/recent`
- [External chats of a section](/docs/chats/discovery/recent-external) — `GET /v1/chats/recent/external`
- [Shared chats with a user](/docs/chats/discovery/shared) — `GET /v1/chats/shared`
- [Chat changes since a moment](/docs/chats/discovery/sync) — `GET /v1/chats/sync`
- [Clear chat history](/docs/chats/management/history-clear) — `POST /v1/chats/*/history/clear`
- [Join a chat](/docs/chats/management/join) — `POST /v1/chats/*/join`
- [Attach to a parent chat](/docs/chats/management/parent) — `PUT /v1/chats/*/parent`
- [Detach from the parent chat](/docs/chats/management/parent-delete) — `DELETE /v1/chats/*/parent`
- [Check access to a chat or message](/docs/chats/discovery/access) — `GET /v1/chats/access`
- [Dialog ID by external identifier](/docs/chats/discovery/dialog-id) — `POST /v1/chats/dialog-id`
- [Load around a message](/docs/chats/messages/load-in-context) — `GET /v1/chats/messages/*/load`
- [Change a chat description](/docs/chats/management/description) — `PUT /v1/chats/*/description`
- [Change a chat color](/docs/chats/management/color) — `PUT /v1/chats/*/color`
- [Change a chat avatar](/docs/chats/management/avatar) — `PUT /v1/chats/*/avatar`
- [Configure message auto-delete](/docs/chats/management/auto-delete) — `PUT /v1/chats/*/auto-delete`
- [Set the permission to post messages](/docs/chats/management/permissions-messages) — `PUT /v1/chats/*/permissions/messages`
- [Set the permission to invite guests](/docs/chats/management/permissions-guest-invites) — `PUT /v1/chats/*/permissions/guest-invites`
- [Set the permission to change chat settings](/docs/chats/management/permissions-settings) — `PUT /v1/chats/*/permissions/settings`
- [Set the permission to change chat appearance](/docs/chats/management/permissions-ui) — `PUT /v1/chats/*/permissions/ui`
- [Set the permission to add members](/docs/chats/management/permissions-users-add) — `PUT /v1/chats/*/permissions/users-add`
- [Set the permission to remove members](/docs/chats/management/permissions-users-delete) — `PUT /v1/chats/*/permissions/users-delete`
- [Users to mention](/docs/chats/members/mentionable) — `GET /v1/chats/*/users/mentionable`
- [Membership check](/docs/chats/members/membership) — `GET /v1/chats/*/users/membership`
- [Transfer chat ownership](/docs/chats/management/owner) — `POST /v1/chats/*/owner`
- [Add managers](/docs/chats/members/managers-add) — `POST /v1/chats/*/managers`
- [Replace managers](/docs/chats/members/managers-set) — `PUT /v1/chats/*/managers`
- [Remove managers](/docs/chats/members/managers-remove) — `DELETE /v1/chats/*/managers`
- [Chat members as entities](/docs/chats/members/member-entities) — `GET /v1/chats/*/member-entities`
- [Active members](/docs/chats/members/active) — `GET /v1/chats/*/users/active`
- [Membership records](/docs/chats/members/relations) — `GET /v1/chats/*/users/relations`
- [Search messages in a chat](/docs/chats/messages/search) — `GET /v1/chats/*/messages/search`
- [Forward messages](/docs/chats/messages/forward) — `POST /v1/chats/*/forward`
- [Typing indicator](/docs/chats/messages/typing) — `POST /v1/chats/*/typing`
- [First page of a chat](/docs/chats/messages/initial) — `GET /v1/chats/*/messages/initial`
- [Who viewed a message](/docs/chats/messages/viewers) — `GET /v1/chats/messages/*/viewers`
- [Disappearing message](/docs/chats/messages/disappear) — `POST /v1/chats/messages/*/disappear`
- [Notify a recipient in Do Not Disturb](/docs/chats/messages/inform) — `POST /v1/chats/messages/*/inform`
- [Remove a link preview](/docs/chats/messages/url-preview) — `DELETE /v1/chats/messages/*/url-preview`
- [Mark messages as read](/docs/chats/messages/read-messages) — `POST /v1/chats/messages/read`
- [Read later](/docs/chats/messages/mark) — `POST /v1/chats/messages/*/mark`
- [Bot commands in a chat](/docs/chats/commands) — `GET /v1/chats/*/commands`
- [Execute a bot command](/docs/chats/messages/command) — `POST /v1/chats/messages/*/command`
- [Unread starting from a message](/docs/chats/messages/unread) — `POST /v1/chats/messages/*/unread`
- [List reactions to a message](/docs/chats/messages/reactions-list) — `GET /v1/chats/messages/*/reactions`
- [Add a reaction](/docs/chats/messages/reactions-create) — `POST /v1/chats/messages/*/reactions`
- [Remove a reaction](/docs/chats/messages/reactions-delete) — `DELETE /v1/chats/messages/*/reactions/*`
- [Pin a message](/docs/chats/messages/pins-create) — `POST /v1/chats/messages/*/pin`
- [Unpin a message](/docs/chats/messages/pins-delete) — `DELETE /v1/chats/messages/*/pin`
- [List pinned messages](/docs/chats/messages/pins) — `GET /v1/chats/*/pins`
- [Remove chat anchors](/docs/chats/messages/anchors) — `POST /v1/chats/*/anchors/read`
- [Remove message anchors](/docs/chats/messages/anchors-messages) — `POST /v1/chats/anchors/read`
- [Mark all channel comments as read](/docs/chats/messages/comments-read-all) — `POST /v1/chats/*/comments/read-all`
- [Follow the comments of a post](/docs/chats/messages/comments-subscription-create) — `POST /v1/chats/messages/*/comments/subscription`
- [Stop following the comments of a post](/docs/chats/messages/comments-subscription-delete) — `DELETE /v1/chats/messages/*/comments/subscription`
- [Open the discussion of a post](/docs/chats/messages/comments-chat) — `POST /v1/chats/messages/*/comments/chat`
- [Comment summary for posts](/docs/chats/messages/comments) — `GET /v1/chats/messages/comments`
- [Add a block to a message](/docs/chats/messages/blocks-create) — `POST /v1/chats/messages/*/blocks`
- [Replace a block of a message](/docs/chats/messages/blocks-update) — `PATCH /v1/chats/messages/*/blocks/*`
- [Remove a block from a message](/docs/chats/messages/blocks-delete) — `DELETE /v1/chats/messages/*/blocks/*`
- [Number of pinned messages](/docs/chats/messages/pins-count) — `GET /v1/chats/*/pins/count`
- [Upload a file to a chat folder](/docs/chats/files/upload-to-folder) — `POST /v1/chats/*/files/uploads`
- [Check whether an uploaded file exists](/docs/chats/files/upload-status) — `POST /v1/chats/files/uploads/status`
- [Discard an uploaded file](/docs/chats/files/upload-discard) — `POST /v1/chats/*/files/uploads/discard`
- [Publish uploaded files](/docs/chats/files/upload-publish) — `POST /v1/chats/*/files/uploads/publish`
- [Save files to Drive](/docs/chats/files/save) — `POST /v1/chats/files/save`
- [Transcribe an audio file](/docs/chats/files/transcribe) — `POST /v1/chats/files/*/transcribe`
- [Get transcription settings](/docs/chats/files/transcribe-transcription-config) — `GET /v1/chats/transcription/config`
- [Chat folders](/docs/chats/discovery/folders) — `GET /v1/chats/folders`
- [Create a chat folder](/docs/chats/management/folders-create) — `POST /v1/chats/folders`
- [Folder chats](/docs/chats/discovery/folder-recent) — `GET /v1/chats/folders/*/recent`
- [Reorder chat folders](/docs/chats/management/folders-order) — `PUT /v1/chats/folders/order`
- [Get a chat folder](/docs/chats/management/folders-get) — `GET /v1/chats/folders/*`
- [Update a chat folder](/docs/chats/management/folders-update) — `PATCH /v1/chats/folders/*`
- [Delete a chat folder](/docs/chats/management/folders-delete) — `DELETE /v1/chats/folders/*`
- [Add chats to a folder](/docs/chats/management/folder-chats) — `POST /v1/chats/folders/*/chats`
- [Remove chats from a folder](/docs/chats/management/folder-chats-delete) — `DELETE /v1/chats/folders/*/chats`
- [Set the folders of a chat](/docs/chats/management/folder-chats-set) — `PUT /v1/chats/*/folders`
- [Stickers](/docs/chats/stickers) — subsection overview
- [List of sticker packs](/docs/chats/stickers/packs) — `GET /v1/chats/stickers/packs`
- [Get a sticker pack](/docs/chats/stickers/pack-get) — `GET /v1/chats/stickers/packs/*`
- [Rename a pack](/docs/chats/stickers/pack-update) — `PATCH /v1/chats/stickers/packs/*`
- [Delete a pack](/docs/chats/stickers/pack-delete) — `DELETE /v1/chats/stickers/packs/*`
- [Add a pack](/docs/chats/stickers/link-create) — `POST /v1/chats/stickers/packs/*/link`
- [Remove a pack](/docs/chats/stickers/link-delete) — `DELETE /v1/chats/stickers/packs/*/link`
- [Delete stickers from a pack](/docs/chats/stickers/pack-stickers) — `DELETE /v1/chats/stickers/packs/*/stickers`
- [Clear the recent list](/docs/chats/stickers/recent) — `DELETE /v1/chats/stickers/recent`
- [Remove a sticker from the recent list](/docs/chats/stickers/recent-delete) — `DELETE /v1/chats/stickers/recent/*`
- [Links and guests](/docs/chats/sharing) — subsection overview
- [Invite guests by email](/docs/chats/sharing/invite-email) — `POST /v1/chats/*/guest-invites/email`
- [Invite guests by SMS](/docs/chats/sharing/invite-phone) — `POST /v1/chats/*/guest-invites/phone`
- [Get a guest link](/docs/chats/sharing/guest-link) — `POST /v1/chats/*/guest-links`
- [Revoke a guest link](/docs/chats/sharing/guest-link-revoke) — `DELETE /v1/chats/*/guest-links`
- [Regenerate a guest link](/docs/chats/sharing/guest-link-regenerate) — `POST /v1/chats/*/guest-links/regenerate`
- [Get the primary chat link](/docs/chats/sharing/primary-link) — `POST /v1/chats/*/sharing-links/primary`
- [Get an individual chat link](/docs/chats/sharing/individual-link) — `POST /v1/chats/*/sharing-links/individual`
- [Regenerate an individual link](/docs/chats/sharing/individual-link-regenerate) — `POST /v1/chats/*/sharing-links/individual/regenerate`
- [Get a link by code](/docs/chats/sharing/link-get) — `GET /v1/chats/sharing-links/*`
- [Revoke a link by code](/docs/chats/sharing/link-revoke) — `DELETE /v1/chats/sharing-links/*`
- [Join a chat by code](/docs/chats/sharing/join) — `POST /v1/chats/join-by-code`
- [CoPilot](/docs/chats/copilot) — subsection overview
- [Change the CoPilot model](/docs/chats/copilot/engine) — `PUT /v1/chats/*/copilot/engine`
- [Change the CoPilot role](/docs/chats/copilot/role) — `PUT /v1/chats/*/copilot/role`
- [CoPilot draft chat](/docs/chats/copilot/draft) — `POST /v1/chats/copilot/draft`
- [Regenerate a CoPilot answer](/docs/chats/copilot/regenerate) — `POST /v1/chats/messages/*/regenerate`
- [Rate an answer](/docs/chats/copilot/vote) — `POST /v1/chats/messages/*/vote`
- [Messenger settings](/docs/chats/settings) — subsection overview
- [Read settings](/docs/chats/settings/list) — `GET /v1/chats/settings`
- [Change a setting](/docs/chats/settings/update) — `PATCH /v1/chats/settings`
- [User status](/docs/chats/settings/status) — `PUT /v1/chats/settings/status`
- [Service methods](/docs/chats/service) — subsection overview
- [Context for bots](/docs/chats/service/bot-context) — `POST /v1/chats/*/bot-context`
- [Flow form](/docs/chats/service/flow-form) — `GET /v1/chats/*/flow-form`
- [Task form](/docs/chats/service/task-form) — `GET /v1/chats/*/task-form`
- [Task form for a message](/docs/chats/service/task-form-message) — `POST /v1/chats/messages/*/task-form`
- [Zoom meeting](/docs/chats/service/zoom) — `POST /v1/chats/*/zoom`
- [Desktop app logout](/docs/chats/service/desktop-logout) — `POST /v1/chats/desktop/logout`
- [Promo hints](/docs/chats/service/promotions) — `GET /v1/chats/promotions`
- [Update state](/docs/chats/service/state) — `GET /v1/chats/state`
- [Plan restrictions](/docs/chats/service/tariff-restrictions) — `GET /v1/chats/tariff-restrictions`
- [User department](/docs/chats/service/department) — `GET /v1/chats/users/*/department`
- [Get events](/docs/chats/events/poll) — `GET /v1/chats/events`

### [Feed](/docs/feed) · `log`

- [Posts](/docs/feed/posts) — subsection overview
- [List posts](/docs/feed/posts/list) — `GET /v1/posts`
- [Create a post](/docs/feed/posts/create) — `POST /v1/posts`
- [Update a post](/docs/feed/posts/update) — `PATCH /v1/posts/*`
- [Delete a post](/docs/feed/posts/delete) — `DELETE /v1/posts/*`
- [Add recipients](/docs/feed/posts/share) — `POST /v1/posts/*/share`
- [Comments](/docs/feed/comments) — subsection overview
- [Add a comment](/docs/feed/comments/add) — `POST /v1/posts/*/comments`
- [Delete a comment](/docs/feed/comments/delete) — `DELETE /v1/posts/*/comments/*`

### [Feed event comments](/docs/feed-comments) · `log`

- [Delete a feed comment](/docs/feed-comments/delete) — `DELETE /v1/feed-comments/*`

### [Mail](/docs/mail) · `mail`

- [Mailboxes](/docs/mail/mailboxes) — subsection overview
- [List mailboxes](/docs/mail/mailboxes/list) — `GET /v1/mail/mailboxes`
- [Get mailbox](/docs/mail/mailboxes/get) — `GET /v1/mail/mailboxes/*`
- [Mail messages](/docs/mail/messages) — subsection overview
- [List messages](/docs/mail/messages/list) — `GET /v1/mail/messages`
- [Send message](/docs/mail/messages/send) — `POST /v1/mail/messages`
- [Mailbox sender addresses](/docs/mail/mailboxes/senders) — `GET /v1/mail/mailboxes/*/senders`
- [Get message](/docs/mail/messages/get) — `GET /v1/mail/messages/*`
- [Conversation thread](/docs/mail/messages/thread) — `GET /v1/mail/messages/*/thread`
- [Move messages](/docs/mail/messages/move) — `POST /v1/mail/messages/move`
- [Create objects from a message](/docs/mail/conversions) — subsection overview
- [Create a CRM activity from a message](/docs/mail/conversions/crm-activity-create) — `POST /v1/mail/messages/*/crm-activity`
- [Delete a CRM activity from a message](/docs/mail/conversions/crm-activity-delete) — `DELETE /v1/mail/messages/*/crm-activity`
- [Mail](/docs/mail) — `POST /v1/mail/messages/*/*`
- [Recipients](/docs/mail/recipients) — subsection overview
- [Search CRM contacts](/docs/mail/recipients/contacts) — `POST /v1/mail/recipients/contacts`
- [Search account employees](/docs/mail/recipients/employees) — `POST /v1/mail/recipients/employees`

### [Notifications](/docs/notifications) · `im`

- [Answer a notification](/docs/notifications/answer) — `POST /v1/notifications/*/answer`
- [Execute a notification button](/docs/notifications/confirm) — `POST /v1/notifications/*/confirm`
- [Search notifications](/docs/notifications/search) — `GET /v1/notifications/search`
- [Send a notification](/docs/notifications/send) — `POST /v1/notifications`
- [Delete all notifications](/docs/notifications/delete-all) — `DELETE /v1/notifications`
- [Notification feed](/docs/notifications/list) — `GET /v1/notifications`
- [Mark as read](/docs/notifications/read) — `POST /v1/notifications/read`
- [Mark all as read](/docs/notifications/read-all) — `POST /v1/notifications/read-all`
- [Delete by id](/docs/notifications/delete) — `DELETE /v1/notifications/*`
- [Delete by tag](/docs/notifications/delete-by-tag) — `DELETE /v1/notifications/by-tag/*`
- [Notification groups](/docs/notifications/groups) — subsection overview
- [List notification groups](/docs/notifications/groups/list) — `GET /v1/notifications/groups`
- [Create a notification group](/docs/notifications/groups/create) — `POST /v1/notifications/groups`
- [Rename a notification group](/docs/notifications/groups/update) — `PATCH /v1/notifications/groups/*`
- [Delete a notification group](/docs/notifications/groups/delete) — `DELETE /v1/notifications/groups/*`
- [Add a condition to a notification group](/docs/notifications/groups/conditions-create) — `POST /v1/notifications/groups/*/conditions`
- [Remove a condition from a notification group](/docs/notifications/groups/conditions-delete) — `DELETE /v1/notifications/groups/*/conditions`
- [Notification settings](/docs/notifications/settings) — subsection overview
- [Get notification settings](/docs/notifications/settings/list) — `GET /v1/notifications/settings`
- [Change a notification setting](/docs/notifications/settings/update) — `PATCH /v1/notifications/settings`
- [Switch the notification settings mode](/docs/notifications/settings/scheme) — `PUT /v1/notifications/settings/scheme`
- [Notification type dictionary](/docs/notifications/schema) — `GET /v1/notifications/schema`

### [Open Channels](/docs/openlines) · `crm` `imopenlines`

- [Open Channel configurations](/docs/openlines/config) — subsection overview
- [Get Open Channel configuration](/docs/openlines/config/get) — `GET /v1/openline-configs/*`
- [Update Open Channel configuration](/docs/openlines/config/update) — `PATCH /v1/openline-configs/*`
- [Delete Open Channel configuration](/docs/openlines/config/delete) — `DELETE /v1/openline-configs/*`
- [Aggregate Open Channel configurations](/docs/openlines/config/aggregate) — `POST /v1/openline-configs/aggregate`
- [Open Channel configuration fields](/docs/openlines/config/fields) — `GET /v1/openline-configs/fields`
- [Send a CRM form to a customer](/docs/openlines/send-form) — `POST /v1/openlines/sessions/send-form`
- [List Open Channel configurations](/docs/openlines/config/list) — `GET /v1/openline-configs`
- [Create Open Channel configuration](/docs/openlines/config/create) — `POST /v1/openline-configs`
- [Search Open Channel configurations](/docs/openlines/config/search) — `POST /v1/openline-configs/search`
- [Channel aggregates for a period](/docs/openlines/stats) — `POST /v1/openlines/stats`
- [Operator actions and my pause](/docs/openlines/operator) — subsection overview
- [Skip a dialog](/docs/openlines/operator/skip) — `POST /v1/openlines/operator/skip`
- [Mark the client as spam](/docs/openlines/operator/spam) — `POST /v1/openlines/operator/spam`
- [Transfer a dialog](/docs/openlines/operator/transfer) — `POST /v1/openlines/operator/transfer`
- [Finish another operator's dialog](/docs/openlines/operator/finish-another) — `POST /v1/openlines/operator/finish-another`
- [Read my pause](/docs/openlines/operator/pause) — `GET /v1/openlines/operator/pause`
- [Start my pause](/docs/openlines/operator/pause-start) — `POST /v1/openlines/operator/pause`
- [Stop my pause](/docs/openlines/operator/pause-stop) — `DELETE /v1/openlines/operator/pause`
- [Open Channel sessions](/docs/openlines/sessions) — subsection overview
- [Open a client chat](/docs/openlines/sessions/open) — `POST /v1/openlines/sessions/open`
- [Start a session](/docs/openlines/sessions/start) — `POST /v1/openlines/sessions/start`
- [Chats by CRM card](/docs/openlines/crm-chats) — `GET /v1/openlines/crm/chats`
- [CRM chat actions](/docs/openlines/crm) — subsection overview
- [Add an employee to a CRM chat](/docs/openlines/crm/members-create) — `POST /v1/openlines/crm/chats/users`
- [Remove an employee from a CRM chat](/docs/openlines/crm/members-delete) — `DELETE /v1/openlines/crm/chats/users`
- [Send a message to the client](/docs/openlines/crm/messages) — `POST /v1/openlines/crm/messages`
- [Create a lead from an inquiry](/docs/openlines/crm/lead) — `POST /v1/openlines/dialogs/*/lead`
- [Open Channel quick replies](/docs/openlines/quick-replies) — subsection overview
- [List quick replies](/docs/openlines/quick-replies/list) — `GET /v1/openline-configs/*/quick-replies`
- [Create a quick reply](/docs/openlines/quick-replies/create) — `POST /v1/openline-configs/*/quick-replies`
- [Update a quick reply](/docs/openlines/quick-replies/update) — `PATCH /v1/openline-configs/*/quick-replies/*`
- [Delete a quick reply](/docs/openlines/quick-replies/delete) — `DELETE /v1/openline-configs/*/quick-replies/*`
- [Operators (real-time)](/docs/openlines/operators) — `GET /v1/openlines/operators`
- [Session search](/docs/openlines/sessions/search) — `POST /v1/openlines/sessions/search`
- [Per-session metrics](/docs/openlines/sessions/stats) — `POST /v1/openlines/sessions/stats`
- [Ratings (CSAT)](/docs/openlines/ratings) — `POST /v1/openlines/ratings/search`
- [Reassignment history](/docs/openlines/sessions/transfers) — `POST /v1/openlines/sessions/transfers`

### [Polls](/docs/polls) · `vote`

- [Find polls by posts or messages](/docs/polls/list) — `GET /v1/polls`
- [Get a poll](/docs/polls/get) — `GET /v1/polls/*`
- [Poll results](/docs/polls/results) — `GET /v1/polls/*/results`
- [List voters for an answer](/docs/polls/voters) — `GET /v1/polls/*/answers/*/voters`
- [Create a chat poll](/docs/polls/create) — `POST /v1/chats/*/polls`
- [Vote or revote](/docs/polls/vote) — `POST /v1/polls/*/vote`
- [Recall a vote](/docs/polls/recall) — `DELETE /v1/polls/*/vote`
- [Stop a poll](/docs/polls/stop) — `POST /v1/polls/*/stop`
- [Resume a poll](/docs/polls/resume) — `POST /v1/polls/*/resume`

### [User comments](/docs/posts/comments) · `log`

- [Read user comments](/docs/posts/comments/read) — `GET /v1/posts/comments`

### [Telephony](/docs/telephony) · `telephony`

- [Lines](/docs/telephony/lines) — subsection overview
- [List application lines](/docs/telephony/lines/list) — `GET /v1/telephony-lines`
- [Add a line](/docs/telephony/lines/create) — `POST /v1/telephony-lines`
- [Update a line](/docs/telephony/lines/update) — `PATCH /v1/telephony-lines/*`
- [Delete a line](/docs/telephony/lines/delete) — `DELETE /v1/telephony-lines/*`
- [Search application lines](/docs/telephony/lines/search) — `POST /v1/telephony-lines/search`
- [Aggregate application lines](/docs/telephony/lines/aggregate) — `POST /v1/telephony-lines/aggregate`
- [Application line fields](/docs/telephony/lines/fields) — `GET /v1/telephony-lines/fields`
- [Calls in CRM](/docs/telephony/crm) — subsection overview
- [Register a call](/docs/telephony/crm/register) — `POST /v1/calls/register`
- [Finish a call](/docs/telephony/crm/finish) — `POST /v1/calls/*/finish`
- [Show the call card](/docs/telephony/crm/show) — `POST /v1/calls/*/show`
- [Hide the call card](/docs/telephony/crm/hide) — `POST /v1/calls/*/hide`
- [Attach a transcription](/docs/telephony/crm/transcription) — `POST /v1/calls/*/transcription`
- [Outbound calls](/docs/telephony/outbound) — subsection overview
- [Start an auto-call with speech synthesis](/docs/telephony/outbound/auto-call) — `POST /v1/calls/auto-call`
- [Start an auto-call with audio file playback](/docs/telephony/outbound/auto-call-audio) — `POST /v1/calls/auto-call-audio`
- [Initiate a callback](/docs/telephony/outbound/callback) — `POST /v1/calls/callback`
- [Analytics and reference data](/docs/telephony/analytics) — subsection overview
- [Call statistics](/docs/telephony/analytics/statistics) — `GET /v1/calls/statistics`
- [Voice reference](/docs/telephony/analytics/voices) — `GET /v1/calls/voices`
- [Voximplant lines](/docs/telephony/lines/voximplant) — `GET /v1/voximplant-lines`

### [Employee telephony](/docs/telephony-users) · `telephony`

- [Employee telephony settings](/docs/telephony-users) — `GET /v1/telephony-users`

### [Telephony lines](/docs/voximplant-lines) · `telephony`

- [Get default outgoing line](/docs/voximplant-lines/default) — `GET /v1/voximplant-lines/default`
- [Set default outgoing line](/docs/voximplant-lines/default-set) — `PUT /v1/voximplant-lines/default`

### [SIP connections](/docs/voximplant-sip) · `telephony`

- [List connections](/docs/voximplant-sip/list) — `GET /v1/voximplant-sip`
- [Create connection](/docs/voximplant-sip/create) — `POST /v1/voximplant-sip`
- [Get connection](/docs/voximplant-sip/get) — `GET /v1/voximplant-sip/*`
- [Update connection](/docs/voximplant-sip/update) — `PATCH /v1/voximplant-sip/*`
- [Delete connection](/docs/voximplant-sip/delete) — `DELETE /v1/voximplant-sip/*`

## People

### [Departments](/docs/entities/departments) · `department`

- [Department list](/docs/entities/departments/list) — `GET /v1/departments`
- [Create a department](/docs/entities/departments/create) — `POST /v1/departments`
- [Get a department](/docs/entities/departments/get) — `GET /v1/departments/*`
- [Update a department](/docs/entities/departments/update) — `PATCH /v1/departments/*`
- [Delete a department](/docs/entities/departments/delete) — `DELETE /v1/departments/*`
- [Department search](/docs/entities/departments/search) — `POST /v1/departments/search`
- [Department fields](/docs/entities/departments/fields) — `GET /v1/departments/fields`

### [Employees](/docs/entities/users) · `user`

- [List employees](/docs/entities/users/list) — `GET /v1/users`
- [Create employee](/docs/entities/users/create) — `POST /v1/users`
- [Get employee](/docs/entities/users/get) — `GET /v1/users/*`
- [Update employee](/docs/entities/users/update) — `PATCH /v1/users/*`
- [Deactivate employee](/docs/entities/users/delete) — `DELETE /v1/users/*`
- [Search employees](/docs/entities/users/search) — `POST /v1/users/search`
- [Aggregate employees](/docs/entities/users/aggregate) — `POST /v1/users/aggregate`
- [Employee fields](/docs/entities/users/fields) — `GET /v1/users/fields`
- [Invite employee](/docs/entities/users/invite) — `POST /v1/users/invite`
- [Current employee profile](/docs/entities/users/me) — `GET /v1/users/me`
- [Remove employee photo](/docs/entities/users/photo-delete) — `DELETE /v1/users/*/personal-photo`

### [Workgroups](/docs/entities/workgroups) · `sonet_group`

- [List workgroups](/docs/entities/workgroups/list) — `GET /v1/workgroups`
- [Create a workgroup](/docs/entities/workgroups/create) — `POST /v1/workgroups`
- [Get a workgroup](/docs/entities/workgroups/get) — `GET /v1/workgroups/*`
- [Update a workgroup](/docs/entities/workgroups/update) — `PATCH /v1/workgroups/*`
- [Delete a workgroup](/docs/entities/workgroups/delete) — `DELETE /v1/workgroups/*`
- [Search workgroups](/docs/entities/workgroups/search) — `POST /v1/workgroups/search`
- [Aggregate workgroups](/docs/entities/workgroups/aggregate) — `POST /v1/workgroups/aggregate`
- [Workgroup fields](/docs/entities/workgroups/fields) — `GET /v1/workgroups/fields`
- [Workgroup members](/docs/entities/workgroups/users) — `GET /v1/workgroups/*/users`

### [Org Structure](/docs/humanresources) · `humanresources`

- [Org structure nodes](/docs/humanresources/nodes) — subsection overview
- [List nodes](/docs/humanresources/nodes/list) — `GET /v1/humanresources/nodes`
- [Create node](/docs/humanresources/nodes/create) — `POST /v1/humanresources/nodes`
- [Get node](/docs/humanresources/nodes/get) — `GET /v1/humanresources/nodes/*`
- [Update node](/docs/humanresources/nodes/update) — `PATCH /v1/humanresources/nodes/*`
- [Aggregate nodes](/docs/humanresources/nodes/aggregate) — `POST /v1/humanresources/nodes/aggregate`
- [Org structure node fields](/docs/humanresources/nodes/fields) — `GET /v1/humanresources/nodes/fields`
- [Search nodes](/docs/humanresources/nodes/search) — `POST /v1/humanresources/nodes/search`
- [Employees](/docs/humanresources/employees) — subsection overview
- [Number of employees](/docs/humanresources/employees/count) — `GET /v1/humanresources/employees/count`
- [Employee subordinates](/docs/humanresources/employees/subordinates) — `GET /v1/humanresources/employees/*/subordinates`
- [Search employees](/docs/humanresources/employees/search) — `POST /v1/humanresources/employees/search`
- [Employees in several departments](/docs/humanresources/employees/multidepartment) — `POST /v1/humanresources/employees/multidepartment`
- [Node operations](/docs/humanresources/node-operations) — subsection overview
- [Node count](/docs/humanresources/node-operations/count) — `GET /v1/humanresources/nodes/count`
- [Child nodes](/docs/humanresources/node-operations/children) — `GET /v1/humanresources/nodes/*/children`
- [Node communication tools](/docs/humanresources/node-operations/communications-get) — `GET /v1/humanresources/nodes/*/communications`
- [Configure communication tools](/docs/humanresources/node-operations/communications-set) — `PATCH /v1/humanresources/nodes/*/communications`
- [Node members](/docs/humanresources/members) — `POST /v1/humanresources/nodes/*/members/*`
- [Move node](/docs/humanresources/node-operations/move) — `POST /v1/humanresources/nodes/*/move`

### [My workgroups](/docs/me/workgroups) · `sonet_group`

- [My workgroups](/docs/me/workgroups) — `GET /v1/me/workgroups`

### [Workday](/docs/workday) · `timeman`

- [Get time-control settings](/docs/workday/time-control-settings-list) — `GET /v1/workday/time-control/settings`
- [Update time-control settings](/docs/workday/time-control-settings-update) — `PATCH /v1/workday/time-control/settings`
- [Get time-control report settings](/docs/workday/time-control-report-settings) — `GET /v1/workday/time-control/report-settings`
- [List department employees](/docs/workday/time-control-users) — `GET /v1/workday/time-control/users`
- [Get the monthly absence report](/docs/workday/time-control-reports) — `GET /v1/workday/time-control/reports`
- [Explain an absence](/docs/workday/time-control-explain) — `POST /v1/workday/time-control/reports/*`
- [Delete a schedule](/docs/workday/schedules-delete) — `DELETE /v1/workday/schedules/*`
- [Add an employee to a schedule](/docs/workday/schedules-users) — `POST /v1/workday/schedules/*/users`
- [Remove an employee from a schedule](/docs/workday/schedules-users-delete) — `DELETE /v1/workday/schedules/*/users/*`
- [Open workday](/docs/workday/open) — `POST /v1/workday/open`
- [Close workday](/docs/workday/close) — `POST /v1/workday/close`
- [Pause](/docs/workday/pause) — `POST /v1/workday/pause`
- [Current status](/docs/workday/status) — `GET /v1/workday/status`
- [Tracking settings](/docs/workday/settings) — `GET /v1/workday/settings`
- [Work schedule](/docs/workday/schedule) — `GET /v1/workday/schedule`
- [Workday history](/docs/workday/records) — `GET /v1/workday/records`
- [Work reports](/docs/workday/work-reports) — subsection overview
- [List work reports](/docs/workday/work-reports/list) — `GET /v1/workday/work-reports`
- [Create a work report](/docs/workday/work-reports/create) — `POST /v1/workday/work-reports`
- [Subordinate work reports](/docs/workday/work-reports/subordinates) — `GET /v1/workday/work-reports/subordinates`
- [Read a work report](/docs/workday/work-reports/get) — `GET /v1/workday/work-reports/*`
- [Update a work report](/docs/workday/work-reports/update) — `PATCH /v1/workday/work-reports/*`
- [Send a work report](/docs/workday/work-reports/send) — `POST /v1/workday/work-reports/*/send`
- [Submit a work report](/docs/workday/work-reports/submit) — `POST /v1/workday/work-reports/submit`
- [Approve a work report](/docs/workday/work-reports/approve) — `POST /v1/workday/work-reports/*/approve`
- [Reject a work report](/docs/workday/work-reports/reject) — `POST /v1/workday/work-reports/*/reject`
- [Disapprove a work report](/docs/workday/work-reports/disapprove) — `POST /v1/workday/work-reports/*/disapprove`
- [Daily reports](/docs/workday/daily-reports) — subsection overview
- [List daily reports](/docs/workday/daily-reports/list) — `GET /v1/workday/daily-reports`
- [Read a daily report](/docs/workday/daily-reports/get) — `GET /v1/workday/records/*/report`
- [Save a daily report](/docs/workday/daily-reports/save) — `PUT /v1/workday/records/*/report`

### [Workgroup members](/docs/workgroups/members) · `sonet_group`

- [Add members](/docs/workgroups/members/add) — `POST /v1/workgroups/*/users`
- [Remove members](/docs/workgroups/members/remove) — `DELETE /v1/workgroups/*/users`
- [Change member role](/docs/workgroups/members/role) — `PATCH /v1/workgroups/*/users`
- [Invite members](/docs/workgroups/members/invite) — `POST /v1/workgroups/*/invitations`
- [Transfer group ownership](/docs/workgroups/members/owner) — `PUT /v1/workgroups/*/owner`

## Content & files

### [Drive agent](/docs/disk) · `disk`

- [Get Drive capabilities](/docs/disk/capabilities) — `GET /v1/disk/capabilities`
- [Search Drive](/docs/disk/search) — `POST /v1/disk/search`
- [Check Drive object visibility](/docs/disk/sync-check) — `POST /v1/disk/sync/check`
- [Reserve a file upload to Drive](/docs/disk/uploads-reserve) — `POST /v1/disk/uploads/reserve`
- [Upload file content to Drive](/docs/disk/uploads) — `POST /v1/disk/uploads`
- [List upload operations](/docs/disk/uploads-list) — `GET /v1/disk/uploads`
- [Get an upload operation](/docs/disk/uploads-get) — `GET /v1/disk/uploads/*`

### [Saved blocks](/docs/entities/block-repository) · `landing`

- [Delete a template from "My blocks"](/docs/entities/block-repository/favorites/delete) — `DELETE /v1/block-repository/favorites/*`

### [CRM document templates](/docs/entities/crm-document-templates) · `crm`

- [List CRM document templates](/docs/entities/crm-document-templates/list) — `GET /v1/crm-document-templates`
- [Create a CRM document template](/docs/entities/crm-document-templates/create) — `POST /v1/crm-document-templates`
- [Get templates for a CRM record](/docs/entities/crm-document-templates/available) — `GET /v1/crm-document-templates/available`
- [Get a CRM document template](/docs/entities/crm-document-templates/get) — `GET /v1/crm-document-templates/*`
- [Update a CRM document template](/docs/entities/crm-document-templates/update) — `PATCH /v1/crm-document-templates/*`
- [Delete a CRM document template](/docs/entities/crm-document-templates/delete) — `DELETE /v1/crm-document-templates/*`
- [Download a CRM document template](/docs/entities/crm-document-templates/download) — `GET /v1/crm-document-templates/*/download`

### [Document templates](/docs/entities/doc-templates) · `disk` `documentgenerator`

- [List templates](/docs/entities/doc-templates/list) — `GET /v1/doc-templates`
- [Create template](/docs/entities/doc-templates/create) — `POST /v1/doc-templates`
- [Get template](/docs/entities/doc-templates/get) — `GET /v1/doc-templates/*`
- [Update template](/docs/entities/doc-templates/update) — `PATCH /v1/doc-templates/*`
- [Delete template](/docs/entities/doc-templates/delete) — `DELETE /v1/doc-templates/*`
- [Search templates](/docs/entities/doc-templates/search) — `POST /v1/doc-templates/search`
- [Aggregate document templates](/docs/entities/doc-templates/aggregate) — `POST /v1/doc-templates/aggregate`
- [Template fields](/docs/entities/doc-templates/fields) — `GET /v1/doc-templates/fields`
- [Download a REST document template](/docs/entities/doc-templates/download) — `GET /v1/doc-templates/*/download`

### [Documents](/docs/entities/documents) · `crm` `documentgenerator`

- [List documents](/docs/entities/documents/list) — `GET /v1/documents`
- [Create document](/docs/entities/documents/create) — `POST /v1/documents`
- [Get document](/docs/entities/documents/get) — `GET /v1/documents/*`
- [Update document](/docs/entities/documents/update) — `PATCH /v1/documents/*`
- [Delete document](/docs/entities/documents/delete) — `DELETE /v1/documents/*`
- [Search documents](/docs/entities/documents/search) — `POST /v1/documents/search`
- [Document fields](/docs/entities/documents/fields) — `GET /v1/documents/fields`
- [Download document DOCX](/docs/entities/documents/download) — `GET /v1/crm-documents/*/download` `GET /v1/documents/*/download`
- [Download document PDF](/docs/entities/documents/pdf) — `GET /v1/crm-documents/*/pdf` `GET /v1/documents/*/pdf`
- [Download document image](/docs/entities/documents/image) — `GET /v1/crm-documents/*/image` `GET /v1/documents/*/image`
- [Documents by CRM record](/docs/entities/documents/crm-list) — `GET /v1/crm-documents`
- [Create a CRM document](/docs/entities/documents/crm-create) — `POST /v1/crm-documents`
- [Get a CRM document](/docs/entities/documents/crm-get) — `GET /v1/crm-documents/*`
- [Update a CRM document](/docs/entities/documents/crm-update) — `PATCH /v1/crm-documents/*`
- [Delete a CRM document](/docs/entities/documents/crm-delete) — `DELETE /v1/crm-documents/*`
- [Enable or disable a CRM document public link](/docs/entities/documents/crm-public-url) — `POST /v1/crm-documents/*/public-url`
- [Upload a CRM document](/docs/entities/documents/crm-upload) — `POST /v1/crm-documents/upload`
- [Enable or disable a document public link](/docs/entities/documents/public-url) — `POST /v1/documents/*/public-url`

### [Files](/docs/entities/files) · `disk`

- [List folder files](/docs/entities/files/list) — `GET /v1/files`
- [Get file](/docs/entities/files/get) — `GET /v1/files/*`
- [Rename file](/docs/entities/files/update) — `PATCH /v1/files/*`
- [Delete file](/docs/entities/files/delete) — `DELETE /v1/files/*`
- [File search](/docs/entities/files/search) — `POST /v1/files/search`
- [File fields](/docs/entities/files/fields) — `GET /v1/files/fields`
- [Upload file](/docs/entities/files/upload) — `POST /v1/files/upload`
- [File version history](/docs/entities/files/versions) — `GET /v1/files/*/versions`
- [Upload a new file version](/docs/entities/files/version-upload) — `POST /v1/files/*/versions`
- [Read a file version](/docs/entities/files/version) — `GET /v1/files/*/versions/*`
- [Download a file version](/docs/entities/files/version-download) — `GET /v1/files/*/versions/*/download`
- [Restore content from a version](/docs/entities/files/version-restore) — `POST /v1/files/*/versions/*/restore`
- [Download file](/docs/entities/files/download) — `GET /v1/files/*/download`
- [Full-text Disk search](/docs/entities/files/fulltext-search) — `POST /v1/files/fulltext-search`
- [Restore file](/docs/entities/files/restore) — `POST /v1/files/*/restore`
- [Permanently delete file](/docs/entities/files/purge) — `POST /v1/files/*/purge`
- [Public link to a file](/docs/entities/files/public-link) — `POST /v1/files/*/public-link`
- [Move file](/docs/entities/files/moveto) — `POST /v1/files/*/moveto`
- [Copy file](/docs/entities/files/copyto) — `POST /v1/files/*/copyto`

### [Folders](/docs/entities/folders) · `disk`

- [List folder contents](/docs/entities/folders/list) — `GET /v1/folders`
- [Create folder](/docs/entities/folders/create) — `POST /v1/folders`
- [Get a folder](/docs/entities/folders/get) — `GET /v1/folders/*`
- [Rename folder](/docs/entities/folders/update) — `PATCH /v1/folders/*`
- [Delete folder](/docs/entities/folders/delete) — `DELETE /v1/folders/*`
- [Folder search](/docs/entities/folders/search) — `POST /v1/folders/search`
- [Folder fields](/docs/entities/folders/fields) — `GET /v1/folders/fields`
- [Restore folder](/docs/entities/folders/restore) — `POST /v1/folders/*/restore`
- [Permanently delete folder](/docs/entities/folders/purge) — `POST /v1/folders/*/purge`
- [Public link to a folder](/docs/entities/folders/public-link) — `POST /v1/folders/*/public-link`
- [Share a folder with a user](/docs/entities/folders/shares) — `POST /v1/folders/*/shares`
- [Folder access levels](/docs/entities/folders/access-levels) — `GET /v1/folders/access-levels`
- [Move folder](/docs/entities/folders/moveto) — `POST /v1/folders/*/moveto`
- [Copy folder](/docs/entities/folders/copyto) — `POST /v1/folders/*/copyto`

### [Page templates](/docs/entities/page-templates) · `landing`

- [List page templates](/docs/entities/page-templates/list) — `GET /v1/page-templates`

### [Pages](/docs/entities/pages) · `landing`

- [List pages](/docs/entities/pages/list) — `GET /v1/pages`
- [Create a page](/docs/entities/pages/create) — `POST /v1/pages`
- [Get a page](/docs/entities/pages/get) — `GET /v1/pages/*`
- [Update a page](/docs/entities/pages/update) — `PATCH /v1/pages/*`
- [Delete a page](/docs/entities/pages/delete) — `DELETE /v1/pages/*`
- [Search pages](/docs/entities/pages/search) — `POST /v1/pages/search`
- [Page aggregation](/docs/entities/pages/aggregate) — `POST /v1/pages/aggregate`
- [Page fields](/docs/entities/pages/fields) — `GET /v1/pages/fields`
- [List page blocks](/docs/entities/pages/blocks/list) — `GET /v1/pages/*/blocks`
- [Add a block to a page](/docs/entities/pages/blocks/create) — `POST /v1/pages/*/blocks`
- [Replace block markup](/docs/entities/pages/blocks/update) — `PATCH /v1/pages/*/blocks/*`
- [Delete a block](/docs/entities/pages/blocks/delete) — `DELETE /v1/pages/*/blocks/*`
- [Read a page block](/docs/entities/pages/block-get) — `GET /v1/pages/*/blocks/*`
- [Restore a block](/docs/entities/pages/blocks/restore) — `POST /v1/pages/*/blocks/*/restore`
- [Block catalog](/docs/entities/pages/catalog) — `GET /v1/block-repository`
- [Pages](/docs/entities/pages) — `POST /v1/pages/*/publication` `POST /v1/pages/*/unpublish`
- [Read block content](/docs/entities/pages/block-content) — `GET /v1/pages/*/blocks/*/content`
- [Read a catalog sample](/docs/entities/pages/catalog-content) — `GET /v1/block-repository/*/content`
- [Read a catalog manifest](/docs/entities/pages/catalog-manifest) — `GET /v1/block-repository/*/manifest`
- [Copy a block](/docs/entities/pages/blocks/copy) — `POST /v1/pages/*/blocks/*/copy`
- [Move a block](/docs/entities/pages/blocks/move) — `POST /v1/pages/*/blocks/*/move`
- [Move a block up](/docs/entities/pages/blocks/up) — `POST /v1/pages/*/blocks/*/up`
- [Move a block down](/docs/entities/pages/blocks/down) — `POST /v1/pages/*/blocks/*/down`
- [Show a block](/docs/entities/pages/blocks/show) — `POST /v1/pages/*/blocks/*/show`
- [Hide a block](/docs/entities/pages/blocks/hide) — `POST /v1/pages/*/blocks/*/hide`
- [Permanently delete a block](/docs/entities/pages/blocks/purge) — `POST /v1/pages/*/blocks/*/purge`
- [Permanently delete selected blocks](/docs/entities/pages/blocks/bulk-purge) — `POST /v1/pages/*/blocks/bulk-purge`
- [Change block text and images](/docs/entities/pages/block-nodes) — `PATCH /v1/pages/*/blocks/*/nodes`
- [Update block styles](/docs/entities/pages/block-styles) — `PATCH /v1/pages/*/blocks/*/styles`
- [Update block attributes](/docs/entities/pages/block-attrs) — `PATCH /v1/pages/*/blocks/*/attrs`
- [Change a block node tag](/docs/entities/pages/block-tags) — `PATCH /v1/pages/*/blocks/*/tags`
- [Set a block anchor](/docs/entities/pages/block-anchor) — `PUT /v1/pages/*/blocks/*/anchor`
- [Upload an image to a block](/docs/entities/pages/block-files) — `POST /v1/pages/*/blocks/*/files`
- [Publish a block](/docs/entities/pages/block-publication) — `POST /v1/pages/*/blocks/*/publication`
- [Block cards](/docs/entities/pages/cards) — subsection overview
- [Clone a block card](/docs/entities/pages/cards/clone) — `POST /v1/pages/*/blocks/*/cards/clone`
- [Add a card with HTML](/docs/entities/pages/cards/add) — `POST /v1/pages/*/blocks/*/cards`
- [Rebuild a card set](/docs/entities/pages/cards/update) — `PUT /v1/pages/*/blocks/*/cards`
- [Remove a card by index](/docs/entities/pages/cards/remove) — `DELETE /v1/pages/*/blocks/*/cards/*`
- [Save a block to "My blocks"](/docs/entities/pages/favorite) — `POST /v1/pages/*/blocks/*/favorite`
- [Move to trash](/docs/entities/pages/trash) — `POST /v1/pages/*/trash`
- [Restore a page](/docs/entities/pages/restore) — `POST /v1/pages/*/restore`
- [Copy a page](/docs/entities/pages/copy) — `POST /v1/pages/*/copy`
- [Move a page](/docs/entities/pages/move) — `POST /v1/pages/*/move`
- [Create from a template](/docs/entities/pages/from-template) — `POST /v1/pages/from-template`
- [Page public URL](/docs/entities/pages/public-url) — `GET /v1/pages/*/public-url`
- [Page preview](/docs/entities/pages/preview) — `GET /v1/pages/*/preview`
- [Page settings](/docs/entities/pages/settings) — `GET /v1/pages/*/settings`
- [Find a page by path](/docs/entities/pages/resolve) — `GET /v1/pages/resolve`
- [Remove a page's system roles](/docs/entities/pages/system-pages) — `DELETE /v1/pages/*/system-pages`
- [Get page template areas](/docs/entities/pages/template-areas-list) — `GET /v1/pages/*/template-areas`
- [Update page template areas](/docs/entities/pages/template-areas-update) — `PATCH /v1/pages/*/template-areas`
- [Clear page template areas](/docs/entities/pages/template-areas-delete) — `DELETE /v1/pages/*/template-areas`

### [Layout templates](/docs/entities/site-templates) · `landing`

- [List layout templates](/docs/entities/site-templates/list) — `GET /v1/site-templates`

### [Sites](/docs/entities/sites) · `landing`

- [List sites](/docs/entities/sites/list) — `GET /v1/sites`
- [Create site](/docs/entities/sites/create) — `POST /v1/sites`
- [Get a site](/docs/entities/sites/get) — `GET /v1/sites/*`
- [Update site](/docs/entities/sites/update) — `PATCH /v1/sites/*`
- [Delete a site](/docs/entities/sites/delete) — `DELETE /v1/sites/*`
- [Search sites](/docs/entities/sites/search) — `POST /v1/sites/search`
- [Site aggregation](/docs/entities/sites/aggregate) — `POST /v1/sites/aggregate`
- [Site fields](/docs/entities/sites/fields) — `GET /v1/sites/fields`
- [List site system pages](/docs/entities/sites/system-pages-list) — `GET /v1/sites/*/system-pages`
- [Remove all site system pages](/docs/entities/sites/system-pages-delete) — `DELETE /v1/sites/*/system-pages`
- [Get a system page URL](/docs/entities/sites/system-pages-url) — `GET /v1/sites/*/system-pages/*/url`
- [Assign a system page](/docs/entities/sites/system-pages-set) — `PUT /v1/sites/*/system-pages/*`
- [Remove a system page](/docs/entities/sites/system-pages-delete-delete) — `DELETE /v1/sites/*/system-pages/*`
- [Get site template areas](/docs/entities/sites/template-areas-list) — `GET /v1/sites/*/template-areas`
- [Update site template areas](/docs/entities/sites/template-areas-update) — `PATCH /v1/sites/*/template-areas`
- [Clear site template areas](/docs/entities/sites/template-areas-delete) — `DELETE /v1/sites/*/template-areas`
- [Knowledge base menu bindings](/docs/entities/sites/menu-bindings) — subsection overview
- [List knowledge base menu bindings](/docs/entities/sites/menu-bindings/list) — `GET /v1/sites/menu-bindings`
- [Bind a knowledge base to a menu](/docs/entities/sites/menu-bindings/bind) — `POST /v1/sites/*/menu-bindings`
- [Unbind a knowledge base from a menu](/docs/entities/sites/menu-bindings/unbind) — `DELETE /v1/sites/*/menu-bindings/*`
- [Knowledge base bindings to a workgroup](/docs/entities/sites/group-binding) — subsection overview
- [List knowledge base bindings to workgroups](/docs/entities/sites/group-binding/list) — `GET /v1/sites/group-bindings`
- [Bind a knowledge base to a workgroup](/docs/entities/sites/group-binding/bind) — `POST /v1/sites/*/group-binding`
- [Unbind a knowledge base from a workgroup](/docs/entities/sites/group-binding/unbind) — `DELETE /v1/sites/*/group-binding/*`
- [Publish site](/docs/entities/sites/publication) — `POST /v1/sites/*/publication`
- [Unpublish site](/docs/entities/sites/unpublish) — `POST /v1/sites/*/unpublish`
- [Move a site to trash](/docs/entities/sites/trash) — `POST /v1/sites/*/trash`
- [Restore a site](/docs/entities/sites/restore) — `POST /v1/sites/*/restore`
- [Site public URL](/docs/entities/sites/public-url) — `GET /v1/sites/*/public-url`
- [Site preview](/docs/entities/sites/preview) — `GET /v1/sites/*/preview`
- [Site settings](/docs/entities/sites/settings) — `GET /v1/sites/*/settings`
- [Full site export](/docs/entities/sites/export) — `GET /v1/sites/*/export`
- [My site permissions](/docs/entities/sites/my-permissions) — `GET /v1/sites/*/my-permissions`
- [Site permissions](/docs/entities/sites/permissions) — `PUT /v1/sites/*/permissions`
- [Reset site permissions](/docs/entities/sites/permissions-delete) — `DELETE /v1/sites/*/permissions`
- [Site folders](/docs/entities/sites/folders) — subsection overview
- [List site folders](/docs/entities/sites/folders/list) — `GET /v1/sites/*/folders`
- [Create folder](/docs/entities/sites/folders/create) — `POST /v1/sites/*/folders`
- [Update folder](/docs/entities/sites/folders/update) — `PATCH /v1/sites/*/folders/*`
- [Move a folder to the trash](/docs/entities/sites/folders/trash) — `POST /v1/sites/*/folders/*/trash`
- [Restore folder](/docs/entities/sites/folders/restore) — `POST /v1/sites/*/folders/*/restore`
- [Publish a folder](/docs/entities/sites/folders/publication) — `POST /v1/sites/*/folders/*/publication`
- [Unpublish folder](/docs/entities/sites/folders/unpublish) — `POST /v1/sites/*/folders/*/unpublish`

### [Storages](/docs/entities/storages) · `disk`

- [List storages](/docs/entities/storages/list) — `GET /v1/storages`
- [Get a storage](/docs/entities/storages/get) — `GET /v1/storages/*`
- [Search storages](/docs/entities/storages/search) — `POST /v1/storages/search`
- [Storage fields](/docs/entities/storages/fields) — `GET /v1/storages/fields`
- [Create a folder at storage root](/docs/entities/storages/folders) — `POST /v1/storages/*/folders`
- [Storage types](/docs/entities/storages/types) — `GET /v1/storages/types`
- [Contents of the storage root](/docs/entities/storages/children) — `POST /v1/storages/*/children`

### [Universal Lists](/docs/lists) · `lists`

- [Lists](/docs/lists/lists) — subsection overview
- [List of lists](/docs/lists/lists/list) — `GET /v1/lists`
- [Create list](/docs/lists/lists/create) — `POST /v1/lists`
- [Get a list](/docs/lists/lists/get) — `GET /v1/lists/*`
- [Update list](/docs/lists/lists/update) — `PATCH /v1/lists/*`
- [Delete list](/docs/lists/lists/delete) — `DELETE /v1/lists/*`
- [Infoblock type](/docs/lists/lists/type) — `GET /v1/lists/*/type`
- [List fields](/docs/lists/fields) — subsection overview
- [List fields](/docs/lists/fields/list) — `GET /v1/lists/*/fields`
- [Create a field](/docs/lists/fields/create) — `POST /v1/lists/*/fields`
- [Get field](/docs/lists/fields/get) — `GET /v1/lists/*/fields/*`
- [Update a field](/docs/lists/fields/update) — `PATCH /v1/lists/*/fields/*`
- [Delete a field](/docs/lists/fields/delete) — `DELETE /v1/lists/*/fields/*`
- [Field types](/docs/lists/fields/field-types) — `GET /v1/lists/*/field-types`
- [Sections](/docs/lists/sections) — subsection overview
- [List sections](/docs/lists/sections/list) — `GET /v1/lists/*/sections`
- [Create a section](/docs/lists/sections/create) — `POST /v1/lists/*/sections`
- [Get section](/docs/lists/sections/get) — `GET /v1/lists/*/sections/*`
- [Update a section](/docs/lists/sections/update) — `PATCH /v1/lists/*/sections/*`
- [Delete a section](/docs/lists/sections/delete) — `DELETE /v1/lists/*/sections/*`
- [Elements](/docs/lists/elements) — subsection overview
- [List elements](/docs/lists/elements/list) — `GET /v1/lists/*/elements`
- [Create an element](/docs/lists/elements/create) — `POST /v1/lists/*/elements`
- [Get element](/docs/lists/elements/get) — `GET /v1/lists/*/elements/*`
- [Update an element](/docs/lists/elements/update) — `PATCH /v1/lists/*/elements/*`
- [Delete an element](/docs/lists/elements/delete) — `DELETE /v1/lists/*/elements/*`
- [Element property files](/docs/lists/elements/files) — `GET /v1/lists/*/elements/*/files/*`

### [Knowledge base](/docs/note) · `note`

- [Knowledge bases](/docs/note/collections) — subsection overview
- [List knowledge bases](/docs/note/collections/list) — `GET /v1/note/collections`
- [Create a knowledge base](/docs/note/collections/create) — `POST /v1/note/collections`
- [Get a knowledge base](/docs/note/collections/get) — `GET /v1/note/collections/*`
- [Rename a knowledge base](/docs/note/collections/update) — `PATCH /v1/note/collections/*`
- [Delete a knowledge base](/docs/note/collections/delete) — `DELETE /v1/note/collections/*`
- [Archive a knowledge base](/docs/note/collections/archive) — `POST /v1/note/collections/*/archive`
- [Knowledge base document tree](/docs/note/collections/tree) — `GET /v1/note/collections/*/documents`
- [Documents](/docs/note/documents) — subsection overview
- [List documents](/docs/note/documents/list) — `GET /v1/note/documents`
- [Create a document](/docs/note/documents/create) — `POST /v1/note/documents`
- [Search documents](/docs/note/documents/search) — `GET /v1/note/documents/search` `POST /v1/note/documents/search`
- [Get a document](/docs/note/documents/get) — `GET /v1/note/documents/*`
- [Update a document](/docs/note/documents/update) — `PATCH /v1/note/documents/*`
- [Delete a document](/docs/note/documents/delete) — `DELETE /v1/note/documents/*`
- [Archive a document](/docs/note/documents/archive) — `POST /v1/note/documents/*/archive`
- [Files](/docs/note/files) — subsection overview
- [Upload file](/docs/note/files/upload) — `POST /v1/note/documents/*/files`
- [Get file metadata](/docs/note/files/get) — `GET /v1/note/documents/*/files/*`
- [Reorder a knowledge base](/docs/note/collections/move) — `POST /v1/note/collections/*/move`
- [Move a document subtree](/docs/note/documents/move) — `POST /v1/note/documents/*/move`

## Sales & inventory

### [Basket item properties](/docs/entities/basket-item-properties) · `sale`

- [List basket item properties](/docs/entities/basket-item-properties/list) — `GET /v1/basket-item-properties`
- [Create a basket item property](/docs/entities/basket-item-properties/create) — `POST /v1/basket-item-properties`
- [Get a basket item property](/docs/entities/basket-item-properties/get) — `GET /v1/basket-item-properties/*`
- [Update a basket item property](/docs/entities/basket-item-properties/update) — `PATCH /v1/basket-item-properties/*`
- [Delete a basket item property](/docs/entities/basket-item-properties/delete) — `DELETE /v1/basket-item-properties/*`
- [Search basket item properties](/docs/entities/basket-item-properties/search) — `POST /v1/basket-item-properties/search`
- [Aggregate basket item properties](/docs/entities/basket-item-properties/aggregate) — `POST /v1/basket-item-properties/aggregate`
- [Basket item property fields](/docs/entities/basket-item-properties/fields) — `GET /v1/basket-item-properties/fields`

### [Basket items](/docs/entities/basket-items) · `sale`

- [List basket items](/docs/entities/basket-items/list) — `GET /v1/basket-items`
- [Add item to basket](/docs/entities/basket-items/create) — `POST /v1/basket-items`
- [Get basket item](/docs/entities/basket-items/get) — `GET /v1/basket-items/*`
- [Update basket item](/docs/entities/basket-items/update) — `PATCH /v1/basket-items/*`
- [Delete basket item](/docs/entities/basket-items/delete) — `DELETE /v1/basket-items/*`
- [Search basket items](/docs/entities/basket-items/search) — `POST /v1/basket-items/search`
- [Aggregate basket items](/docs/entities/basket-items/aggregate) — `POST /v1/basket-items/aggregate`
- [Basket item fields](/docs/entities/basket-items/fields) — `GET /v1/basket-items/fields`

### [Inventory document items](/docs/entities/catalog-document-elements) · `catalog`

- [List inventory document items](/docs/entities/catalog-document-elements/list) — `GET /v1/catalog-document-elements`
- [Create an inventory document item](/docs/entities/catalog-document-elements/create) — `POST /v1/catalog-document-elements`
- [Get an inventory document item](/docs/entities/catalog-document-elements/get) — `GET /v1/catalog-document-elements/*`
- [Update an inventory document item](/docs/entities/catalog-document-elements/update) — `PATCH /v1/catalog-document-elements/*`
- [Delete an inventory document item](/docs/entities/catalog-document-elements/delete) — `DELETE /v1/catalog-document-elements/*`
- [Search inventory document items](/docs/entities/catalog-document-elements/search) — `POST /v1/catalog-document-elements/search`
- [Inventory document item fields](/docs/entities/catalog-document-elements/fields) — `GET /v1/catalog-document-elements/fields`

### [Inventory documents](/docs/entities/catalog-documents) · `catalog`

- [List inventory documents](/docs/entities/catalog-documents/list) — `GET /v1/catalog-documents`
- [Create an inventory document](/docs/entities/catalog-documents/create) — `POST /v1/catalog-documents`
- [Get an inventory document](/docs/entities/catalog-documents/get) — `GET /v1/catalog-documents/*`
- [Update an inventory document](/docs/entities/catalog-documents/update) — `PATCH /v1/catalog-documents/*`
- [Delete an inventory document](/docs/entities/catalog-documents/delete) — `DELETE /v1/catalog-documents/*`
- [Search inventory documents](/docs/entities/catalog-documents/search) — `POST /v1/catalog-documents/search`
- [Inventory document fields](/docs/entities/catalog-documents/fields) — `GET /v1/catalog-documents/fields`
- [Conduct an inventory document](/docs/entities/catalog-documents/conduct) — `POST /v1/catalog-documents/*/conduct`
- [Cancel conducting of an inventory document](/docs/entities/catalog-documents/cancel) — `POST /v1/catalog-documents/*/cancel`

### [Catalog measures](/docs/entities/catalog-measures) · `catalog`

- [List units of measure](/docs/entities/catalog-measures/list) — `GET /v1/catalog-measures`
- [Create a unit of measure](/docs/entities/catalog-measures/create) — `POST /v1/catalog-measures`
- [Get a unit of measure](/docs/entities/catalog-measures/get) — `GET /v1/catalog-measures/*`
- [Update a unit of measure](/docs/entities/catalog-measures/update) — `PATCH /v1/catalog-measures/*`
- [Delete a unit of measure](/docs/entities/catalog-measures/delete) — `DELETE /v1/catalog-measures/*`
- [Search units of measure](/docs/entities/catalog-measures/search) — `POST /v1/catalog-measures/search`
- [Unit of measure fields](/docs/entities/catalog-measures/fields) — `GET /v1/catalog-measures/fields`

### [Catalog offers](/docs/entities/catalog-offers) · `catalog`

- [List offers](/docs/entities/catalog-offers/list) — `GET /v1/catalog-offers`
- [Create an offer](/docs/entities/catalog-offers/create) — `POST /v1/catalog-offers`
- [Get an offer](/docs/entities/catalog-offers/get) — `GET /v1/catalog-offers/*`
- [Update an offer](/docs/entities/catalog-offers/update) — `PATCH /v1/catalog-offers/*`
- [Delete an offer](/docs/entities/catalog-offers/delete) — `DELETE /v1/catalog-offers/*`
- [Search offers](/docs/entities/catalog-offers/search) — `POST /v1/catalog-offers/search`
- [Aggregate offers](/docs/entities/catalog-offers/aggregate) — `POST /v1/catalog-offers/aggregate`
- [Offer fields](/docs/entities/catalog-offers/fields) — `GET /v1/catalog-offers/fields`

### [Catalog price types](/docs/entities/catalog-price-types) · `catalog`

- [List price types](/docs/entities/catalog-price-types/list) — `GET /v1/catalog-price-types`
- [Create a price type](/docs/entities/catalog-price-types/create) — `POST /v1/catalog-price-types`
- [Get a price type](/docs/entities/catalog-price-types/get) — `GET /v1/catalog-price-types/*`
- [Update a price type](/docs/entities/catalog-price-types/update) — `PATCH /v1/catalog-price-types/*`
- [Delete a price type](/docs/entities/catalog-price-types/delete) — `DELETE /v1/catalog-price-types/*`
- [Search price types](/docs/entities/catalog-price-types/search) — `POST /v1/catalog-price-types/search`
- [Price type fields](/docs/entities/catalog-price-types/fields) — `GET /v1/catalog-price-types/fields`

### [Catalog prices](/docs/entities/catalog-prices) · `catalog`

- [List prices](/docs/entities/catalog-prices/list) — `GET /v1/catalog-prices`
- [Create a price](/docs/entities/catalog-prices/create) — `POST /v1/catalog-prices`
- [Get a price](/docs/entities/catalog-prices/get) — `GET /v1/catalog-prices/*`
- [Update a price](/docs/entities/catalog-prices/update) — `PATCH /v1/catalog-prices/*`
- [Delete a price](/docs/entities/catalog-prices/delete) — `DELETE /v1/catalog-prices/*`
- [Search prices](/docs/entities/catalog-prices/search) — `POST /v1/catalog-prices/search`
- [Price fields](/docs/entities/catalog-prices/fields) — `GET /v1/catalog-prices/fields`

### [Catalog product properties](/docs/entities/catalog-product-properties) · `catalog`

- [List properties](/docs/entities/catalog-product-properties/list) — `GET /v1/catalog-product-properties`
- [Create a product property](/docs/entities/catalog-product-properties/create) — `POST /v1/catalog-product-properties`
- [Get a property](/docs/entities/catalog-product-properties/get) — `GET /v1/catalog-product-properties/*`
- [Update a property](/docs/entities/catalog-product-properties/update) — `PATCH /v1/catalog-product-properties/*`
- [Delete a property](/docs/entities/catalog-product-properties/delete) — `DELETE /v1/catalog-product-properties/*`
- [Search product properties](/docs/entities/catalog-product-properties/search) — `POST /v1/catalog-product-properties/search`
- [Property fields](/docs/entities/catalog-product-properties/fields) — `GET /v1/catalog-product-properties/fields`

### [Catalog list-property values](/docs/entities/catalog-product-property-enums) · `catalog`

- [List values](/docs/entities/catalog-product-property-enums/list) — `GET /v1/catalog-product-property-enums`
- [Create a list-property value](/docs/entities/catalog-product-property-enums/create) — `POST /v1/catalog-product-property-enums`
- [Get a value](/docs/entities/catalog-product-property-enums/get) — `GET /v1/catalog-product-property-enums/*`
- [Update a list-property value](/docs/entities/catalog-product-property-enums/update) — `PATCH /v1/catalog-product-property-enums/*`
- [Delete a list-property value](/docs/entities/catalog-product-property-enums/delete) — `DELETE /v1/catalog-product-property-enums/*`
- [Search values](/docs/entities/catalog-product-property-enums/search) — `POST /v1/catalog-product-property-enums/search`
- [Value fields](/docs/entities/catalog-product-property-enums/fields) — `GET /v1/catalog-product-property-enums/fields`

### [Catalog products](/docs/entities/catalog-products) · `catalog`

- [List catalog products](/docs/entities/catalog-products/list) — `GET /v1/catalog-products`
- [Create catalog product](/docs/entities/catalog-products/create) — `POST /v1/catalog-products`
- [Get catalog product](/docs/entities/catalog-products/get) — `GET /v1/catalog-products/*`
- [Update catalog product](/docs/entities/catalog-products/update) — `PATCH /v1/catalog-products/*`
- [Delete catalog product](/docs/entities/catalog-products/delete) — `DELETE /v1/catalog-products/*`
- [Search catalog products](/docs/entities/catalog-products/search) — `POST /v1/catalog-products/search`
- [Aggregate catalog products](/docs/entities/catalog-products/aggregate) — `POST /v1/catalog-products/aggregate`
- [Catalog product fields](/docs/entities/catalog-products/fields) — `GET /v1/catalog-products/fields`
- [Upload product image](/docs/entities/catalog-products/images-create) — `POST /v1/catalog-products/*/images`
- [List product images](/docs/entities/catalog-products/images-list) — `GET /v1/catalog-products/*/images`
- [Delete product image](/docs/entities/catalog-products/images-delete) — `DELETE /v1/catalog-products/*/images/*`
- [Get product image](/docs/entities/catalog-products/images-get) — `GET /v1/catalog-products/*/images/*`

### [Catalog sections](/docs/entities/catalog-sections) · `catalog`

- [List sections](/docs/entities/catalog-sections/list) — `GET /v1/catalog-sections`
- [Create a section](/docs/entities/catalog-sections/create) — `POST /v1/catalog-sections`
- [Get a section](/docs/entities/catalog-sections/get) — `GET /v1/catalog-sections/*`
- [Update a section](/docs/entities/catalog-sections/update) — `PATCH /v1/catalog-sections/*`
- [Delete a section](/docs/entities/catalog-sections/delete) — `DELETE /v1/catalog-sections/*`
- [Search sections](/docs/entities/catalog-sections/search) — `POST /v1/catalog-sections/search`
- [Section fields](/docs/entities/catalog-sections/fields) — `GET /v1/catalog-sections/fields`

### [Catalog services](/docs/entities/catalog-services) · `catalog`

- [List services](/docs/entities/catalog-services/list) — `GET /v1/catalog-services`
- [Create a service](/docs/entities/catalog-services/create) — `POST /v1/catalog-services`
- [Get a service](/docs/entities/catalog-services/get) — `GET /v1/catalog-services/*`
- [Update a service](/docs/entities/catalog-services/update) — `PATCH /v1/catalog-services/*`
- [Delete a service](/docs/entities/catalog-services/delete) — `DELETE /v1/catalog-services/*`
- [Search services](/docs/entities/catalog-services/search) — `POST /v1/catalog-services/search`
- [Aggregate services](/docs/entities/catalog-services/aggregate) — `POST /v1/catalog-services/aggregate`
- [Service fields](/docs/entities/catalog-services/fields) — `GET /v1/catalog-services/fields`

### [Catalog SKUs](/docs/entities/catalog-skus) · `catalog`

- [List SKUs](/docs/entities/catalog-skus/list) — `GET /v1/catalog-skus`
- [Create an SKU](/docs/entities/catalog-skus/create) — `POST /v1/catalog-skus`
- [Get an SKU](/docs/entities/catalog-skus/get) — `GET /v1/catalog-skus/*`
- [Update an SKU](/docs/entities/catalog-skus/update) — `PATCH /v1/catalog-skus/*`
- [Delete an SKU](/docs/entities/catalog-skus/delete) — `DELETE /v1/catalog-skus/*`
- [Search SKUs](/docs/entities/catalog-skus/search) — `POST /v1/catalog-skus/search`
- [Aggregate SKUs](/docs/entities/catalog-skus/aggregate) — `POST /v1/catalog-skus/aggregate`
- [SKU fields](/docs/entities/catalog-skus/fields) — `GET /v1/catalog-skus/fields`

### [Catalog VAT rates](/docs/entities/catalog-vat-rates) · `catalog`

- [List VAT rates](/docs/entities/catalog-vat-rates/list) — `GET /v1/catalog-vat-rates`
- [Create a VAT rate](/docs/entities/catalog-vat-rates/create) — `POST /v1/catalog-vat-rates`
- [Get a VAT rate](/docs/entities/catalog-vat-rates/get) — `GET /v1/catalog-vat-rates/*`
- [Update a VAT rate](/docs/entities/catalog-vat-rates/update) — `PATCH /v1/catalog-vat-rates/*`
- [Delete a VAT rate](/docs/entities/catalog-vat-rates/delete) — `DELETE /v1/catalog-vat-rates/*`
- [Search VAT rates](/docs/entities/catalog-vat-rates/search) — `POST /v1/catalog-vat-rates/search`
- [VAT rate fields](/docs/entities/catalog-vat-rates/fields) — `GET /v1/catalog-vat-rates/fields`

### [Catalogs](/docs/entities/catalogs) · `catalog`

- [List of catalogs](/docs/entities/catalogs/list) — `GET /v1/catalogs`
- [Get a catalog](/docs/entities/catalogs/get) — `GET /v1/catalogs/*`
- [Search catalogs](/docs/entities/catalogs/search) — `POST /v1/catalogs/search`
- [Catalog fields](/docs/entities/catalogs/fields) — `GET /v1/catalogs/fields`

### [Delivery services](/docs/entities/delivery-services) · `delivery`

- [List delivery services](/docs/entities/delivery-services/list) — `GET /v1/delivery-services`
- [Create a delivery service](/docs/entities/delivery-services/create) — `POST /v1/delivery-services`
- [Get a delivery service](/docs/entities/delivery-services/get) — `GET /v1/delivery-services/*`
- [Update a delivery service](/docs/entities/delivery-services/update) — `PATCH /v1/delivery-services/*`
- [Delete a delivery service](/docs/entities/delivery-services/delete) — `DELETE /v1/delivery-services/*`
- [List delivery handlers](/docs/entities/delivery-services/handlers) — `GET /v1/delivery-services/handlers`

### [Order properties](/docs/entities/order-properties) · `sale`

- [List order properties](/docs/entities/order-properties/list) — `GET /v1/order-properties`
- [Create an order property](/docs/entities/order-properties/create) — `POST /v1/order-properties`
- [Get an order property](/docs/entities/order-properties/get) — `GET /v1/order-properties/*`
- [Update an order property](/docs/entities/order-properties/update) — `PATCH /v1/order-properties/*`
- [Delete an order property](/docs/entities/order-properties/delete) — `DELETE /v1/order-properties/*`
- [Search order properties](/docs/entities/order-properties/search) — `POST /v1/order-properties/search`
- [Aggregate order properties](/docs/entities/order-properties/aggregate) — `POST /v1/order-properties/aggregate`
- [Order property fields](/docs/entities/order-properties/fields) — `GET /v1/order-properties/fields`

### [Order statuses](/docs/entities/order-statuses) · `sale`

- [List order statuses](/docs/entities/order-statuses/list) — `GET /v1/order-statuses`
- [Create order status](/docs/entities/order-statuses/create) — `POST /v1/order-statuses`
- [Get order status](/docs/entities/order-statuses/get) — `GET /v1/order-statuses/*`
- [Update order status](/docs/entities/order-statuses/update) — `PATCH /v1/order-statuses/*`
- [Delete order status](/docs/entities/order-statuses/delete) — `DELETE /v1/order-statuses/*`
- [Search order statuses](/docs/entities/order-statuses/search) — `POST /v1/order-statuses/search`
- [Aggregate order statuses](/docs/entities/order-statuses/aggregate) — `POST /v1/order-statuses/aggregate`
- [Order status fields](/docs/entities/order-statuses/fields) — `GET /v1/order-statuses/fields`

### [Orders](/docs/entities/orders) · `sale`

- [List orders](/docs/entities/orders/list) — `GET /v1/orders`
- [Create an order](/docs/entities/orders/create) — `POST /v1/orders`
- [Get an order](/docs/entities/orders/get) — `GET /v1/orders/*`
- [Update an order](/docs/entities/orders/update) — `PATCH /v1/orders/*`
- [Delete an order](/docs/entities/orders/delete) — `DELETE /v1/orders/*`
- [Search orders](/docs/entities/orders/search) — `POST /v1/orders/search`
- [Aggregate orders](/docs/entities/orders/aggregate) — `POST /v1/orders/aggregate`
- [Order fields](/docs/entities/orders/fields) — `GET /v1/orders/fields`

### [Pay systems](/docs/entities/pay-systems) · `pay_system`

- [List payment systems](/docs/entities/pay-systems/list) — `GET /v1/pay-systems`
- [Create a pay system](/docs/entities/pay-systems/create) — `POST /v1/pay-systems`
- [Get a payment system](/docs/entities/pay-systems/get) — `GET /v1/pay-systems/*`
- [Update a pay system](/docs/entities/pay-systems/update) — `PATCH /v1/pay-systems/*`
- [Delete a pay system](/docs/entities/pay-systems/delete) — `DELETE /v1/pay-systems/*`
- [List pay system handlers](/docs/entities/pay-systems/handlers) — `GET /v1/pay-systems/handlers`

### [Payments](/docs/entities/payments) · `sale`

- [List payments](/docs/entities/payments/list) — `GET /v1/payments`
- [Create a payment](/docs/entities/payments/create) — `POST /v1/payments`
- [Get a payment](/docs/entities/payments/get) — `GET /v1/payments/*`
- [Update a payment](/docs/entities/payments/update) — `PATCH /v1/payments/*`
- [Delete a payment](/docs/entities/payments/delete) — `DELETE /v1/payments/*`
- [Search payments](/docs/entities/payments/search) — `POST /v1/payments/search`
- [Aggregate payments](/docs/entities/payments/aggregate) — `POST /v1/payments/aggregate`
- [Payment fields](/docs/entities/payments/fields) — `GET /v1/payments/fields`

### [Payer types](/docs/entities/person-types) · `sale`

- [List payer types](/docs/entities/person-types/list) — `GET /v1/person-types`
- [Create a payer type](/docs/entities/person-types/create) — `POST /v1/person-types`
- [Get a payer type](/docs/entities/person-types/get) — `GET /v1/person-types/*`
- [Update a payer type](/docs/entities/person-types/update) — `PATCH /v1/person-types/*`
- [Delete a payer type](/docs/entities/person-types/delete) — `DELETE /v1/person-types/*`
- [Search payer types](/docs/entities/person-types/search) — `POST /v1/person-types/search`
- [Aggregate payer types](/docs/entities/person-types/aggregate) — `POST /v1/person-types/aggregate`
- [Payer type fields](/docs/entities/person-types/fields) — `GET /v1/person-types/fields`

### [Shipment items](/docs/entities/shipment-items) · `sale`

- [List shipment items](/docs/entities/shipment-items/list) — `GET /v1/shipment-items`
- [Create a shipment item](/docs/entities/shipment-items/create) — `POST /v1/shipment-items`
- [Get a shipment item](/docs/entities/shipment-items/get) — `GET /v1/shipment-items/*`
- [Update a shipment item](/docs/entities/shipment-items/update) — `PATCH /v1/shipment-items/*`
- [Delete a shipment item](/docs/entities/shipment-items/delete) — `DELETE /v1/shipment-items/*`
- [Search shipment items](/docs/entities/shipment-items/search) — `POST /v1/shipment-items/search`
- [Batch operations on shipment items](/docs/entities/shipment-items/batch) — `POST /v1/shipment-items/batch`
- [Aggregate shipment items](/docs/entities/shipment-items/aggregate) — `POST /v1/shipment-items/aggregate`
- [Shipment item fields](/docs/entities/shipment-items/fields) — `GET /v1/shipment-items/fields`

### [Shipments](/docs/entities/shipments) · `sale`

- [List shipments](/docs/entities/shipments/list) — `GET /v1/shipments`
- [Create a shipment](/docs/entities/shipments/create) — `POST /v1/shipments`
- [Get a shipment](/docs/entities/shipments/get) — `GET /v1/shipments/*`
- [Update a shipment](/docs/entities/shipments/update) — `PATCH /v1/shipments/*`
- [Delete a shipment](/docs/entities/shipments/delete) — `DELETE /v1/shipments/*`
- [Search shipments](/docs/entities/shipments/search) — `POST /v1/shipments/search`
- [Shipment aggregation](/docs/entities/shipments/aggregate) — `POST /v1/shipments/aggregate`
- [Shipment fields](/docs/entities/shipments/fields) — `GET /v1/shipments/fields`
- [Set the "shipped" mark](/docs/entities/shipments/ship) — `POST /v1/shipments/*/ship`
- [Clear the "shipped" mark](/docs/entities/shipments/unship) — `POST /v1/shipments/*/unship`

### [Warehouses](/docs/entities/warehouses) · `catalog`

- [List warehouses](/docs/entities/warehouses/list) — `GET /v1/warehouses`
- [Create a warehouse](/docs/entities/warehouses/create) — `POST /v1/warehouses`
- [Get a warehouse](/docs/entities/warehouses/get) — `GET /v1/warehouses/*`
- [Update a warehouse](/docs/entities/warehouses/update) — `PATCH /v1/warehouses/*`
- [Delete a warehouse](/docs/entities/warehouses/delete) — `DELETE /v1/warehouses/*`
- [Warehouse stock](/docs/entities/warehouses/stock) — `GET /v1/warehouses/*/stock`
- [Warehouse stock record](/docs/entities/warehouses/stock-record) — `GET /v1/warehouses/*/stock/*`
- [Aggregated product stock](/docs/entities/warehouses/stock-totals) — `GET /v1/warehouses/stock/totals`
- [Warehouse fields](/docs/entities/warehouses/fields) — `GET /v1/warehouses/fields`

## Business processes

### [Business process activities](/docs/entities/bizproc-activities) · `bizproc`

- [Activity list](/docs/entities/bizproc-activities/list) — `GET /v1/bizproc-activities`
- [Register an activity](/docs/entities/bizproc-activities/create) — `POST /v1/bizproc-activities`
- [Update an activity](/docs/entities/bizproc-activities/update) — `PATCH /v1/bizproc-activities/*`
- [Delete an activity](/docs/entities/bizproc-activities/delete) — `DELETE /v1/bizproc-activities/*`
- [Activity fields](/docs/entities/bizproc-activities/fields) — `GET /v1/bizproc-activities/fields`

### [Automation rules](/docs/entities/bizproc-robots) · `bizproc`

- [Automation rule list](/docs/entities/bizproc-robots/list) — `GET /v1/bizproc-robots`
- [Register an automation rule](/docs/entities/bizproc-robots/create) — `POST /v1/bizproc-robots`
- [Update an automation rule](/docs/entities/bizproc-robots/update) — `PATCH /v1/bizproc-robots/*`
- [Delete an automation rule](/docs/entities/bizproc-robots/delete) — `DELETE /v1/bizproc-robots/*`
- [Automation rule fields](/docs/entities/bizproc-robots/fields) — `GET /v1/bizproc-robots/fields`

### [Business process templates](/docs/entities/bizproc-templates) · `bizproc`

- [Template list](/docs/entities/bizproc-templates/list) — `GET /v1/bizproc-templates`
- [Upload a template](/docs/entities/bizproc-templates/create) — `POST /v1/bizproc-templates`
- [Update a template](/docs/entities/bizproc-templates/update) — `PATCH /v1/bizproc-templates/*`
- [Delete a template](/docs/entities/bizproc-templates/delete) — `DELETE /v1/bizproc-templates/*`
- [Template search](/docs/entities/bizproc-templates/search) — `POST /v1/bizproc-templates/search`
- [Template fields](/docs/entities/bizproc-templates/fields) — `GET /v1/bizproc-templates/fields`

### [Feedback](/docs/feedback)

- [Submit a ticket](/docs/feedback/submit) — `POST /v1/feedback`
- [List tickets](/docs/feedback/list) — `GET /v1/feedback`
- [Get a ticket](/docs/feedback/get) — `GET /v1/feedback/*`
- [Update a ticket](/docs/feedback/update) — `PATCH /v1/feedback/*`
- [Add a comment](/docs/feedback/comments) — `POST /v1/feedback/*/comments`
- [Upload an attachment](/docs/feedback/attachments) — `POST /v1/feedback/attachments`

<!-- END GENERATED: api-reference-hub -->

## Common capabilities

All entity endpoints support:

- **[Filtering](/docs/filtering):** `?filter[stageId]=NEW` or `?filter[$gte][amount]=1000` (MongoDB operators)
- **Sorting:** `?sort=-createdAt` (`-` prefix for descending order)
- **Pagination:** `?limit=50&offset=100` (auto-pagination when limit > 50)
- **Field selection:** `?select=id,title,amount`
- **Field transformation:** camelCase names are automatically converted to Bitrix24 field names
- **Field metadata:** `GET /v1/{entity}/fields` returns field descriptions, including custom UF fields with labels. For enumeration fields, the response includes an `items` array of available values
- **Search:** `POST /v1/{entity}/search` — advanced search with automatic date-based splitting for large data sets
- **Aggregation:** `POST /v1/{entity}/aggregate` — count, sum, average, minimum, maximum over fields
- **Product rows:** for CRM entities with products (deals, leads, quotes, invoices, smart process items), the routes `GET/POST/PUT/PATCH/DELETE /v1/{entity}/{id}/products` are available
- **[Related data (include)](/docs/includes):** `?include=company,contact` loads related entities in a single request