- Introduction to Web API
- Authorization
- Data types
- Data import
- Working with filters
- Working with filters in reports
- Additional field attributes
- Partial and eager loading of app fields
-
Public Web API
- Managing apps
- Managing business processes
-
Managing files
- Bulk file deletion (PATCH)
- Bulk file initialization (POST)
- Bulk receiving of file upload links (POST)
- Bulk retrieval of file download links (POST)
- Bulk upload of files and links (POST)
- Directory is created (POST)
- Get a list of directories (GET)
- Get a list of directories (POST)
- Get file download link by file ID (GET)
- Get file download link by file ID (POST)
- Get information about a directory by ID (GET)
- Load a file to a directory (POST)
- Moving a file to a directory (POST)
- Upload a temporary file (POST)
- Managing users
-
Working with metadata
- Add organizational units to a group (POST)
- Create a group’s metadata description (POST)
- Delete a group (DELETE)
- Delete organizational units from a group (POST)
- Edit group data (PUT)
- Get a group metadata description instance by ID (GET)
- Get a list of an app’s document templates’ metadata descriptions (GET)
- Get a list of document templates’ metadata descriptions (GET)
- Get a list of groups the specified group is included in (GET)
- Get a list of metadata descriptions of filtered groups (GET)
- Get a list of metadata descriptions of filtered groups (POST)
- Get a list of metadata descriptions of groups and roles by app (GET)
- Get a list of modules’ metadata descriptions (GET)
- Get a list of pages’ metadata descriptions (GET)
- Get a list of positions included in a group (GET)
- Get a list of process templates’ metadata descriptions by app (GET)
- Get a list of solutions’ metadata descriptions (GET)
- Get a list of sub-groups of a specified group (GET)
- Get a list of users included in a group (GET)
- Get app metadata description by code (GET)
- Get list of app metadata descriptions (GET)
- Get list of process tempalte metadata descriptions (GET)
- Get list of workspace metadata descriptions (GET)
- Get metadata descriptions of a module by ID (GET)
- Get process template metadata description by code (GET)
- Get the list of metadata descriptions of groups (GET)
- Get the metadata description of a document template by ID (GET)
- Get the metadata description of a page by ID (GET)
- Get the metadata description of a solution by code (GET)
- Get workspace metadata description by code (GET)
- Whether the app can be exported using its code (GET)
- Whether the module can be exported using its ID (GET)
- Whether the solution can be exported using its code (GET)
- Whether the workspace can be exported using its code (GET)
- Work with modules
- Working with contracts
- Working with reports
- Work with marketing
- Work with document registration
- OpenAPI specification
Get the segment by ID
Request
GET /pub/v1/marketing/segment/{id}
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| id | uuid | Segment ID |
Required |
Authorization
This request requires the use of one of following authorisation methods:
API key
Response
The following HTTP status codes may be returned:
| Status code | Description | Resource |
|---|---|---|
| 200 | OK Model of a list of segments |
Model of a list of segments (Get the segment by ID) |
| 400 | Bad Request Error while checking incoming data or implementing the method |
|
| 412 | Precondition Failed No CRM license |