Get a list of segments
Request
POST /pub/v1/marketing/segment
Request body
The resource sent in the request body is Get a list of segments — Request. It contains the following writable properties:
{
"filter": {
"<key>": {}
},
"from": "uint32",
"size": "uint32"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| filter | object |
Filter |
Optional |
| filter.<key> | map of object | Optional | |
| from | uint32 |
Return starting from item |
Optional |
| size | uint32 |
Number of returned items (10000 max) |
Optional |
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 a list of segments) |
| 400 | Bad Request Error while checking incoming data or implementing the method |
|
| 412 | Precondition Failed No CRM license |