API Reference

Get a collection of segment records

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers//segment-records

Get information about all segment records on a customer account.

Segments are groupings of customers based on shared attributes or behaviour, used for targeted marketing and personalisation. This endpoint returns all segment memberships currently recorded on the customer account.

Related: GET /segments

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of the customer.

Query Params
segment_group_ids
array of strings
length ≤ 1000

List of the segment group IDs from the resource GET /segment-groups.
In case you want to filter multiple options use array syntax : segment_group_ids[]=8bed991c68a470e7aaeffbf048&segment_group_ids[]=9cfe0a2d79b581f8bb5ffc059
Logic OR is used between values.

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

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

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago