API Reference
Start typing to search…

Get all customer engagement setups

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/customer-engagement-setups

The endpoint returns all available setups for customer engagement

Log in to see full request history
Query Params
integer
≥ 1
Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

integer
≥ 0
Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

string

Direction of sorting the response list.

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body
object
data
object
customer_engagement_setups
array of objects

List of all setups.

customer_engagement_setups
object
string

The unique ID of the customer engagement setup.

string

Serialized JSON contains the customer engagement setup for the application

integer

State of the customer engagement setup. Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

integer

The number of all found setups.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 11 months ago

Did this page help you?
Language
Credentials
URL

Updated 11 months ago

Did this page help you?