Skip to main content
GET
Get persons in a segment

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Path Parameters

segmentId
integer<int64>
required

A unique segment identifier.

Example:

42

Query Parameters

page
integer
default:0

Zero-based page index (0..N).

size
integer
default:20

The size of the page to be returned.

Required range: 1 <= x <= 1000
sort
string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK

results
PersonV3 · object[]
required

The list of the results for this page.

paging
PageInfo · object
required

Contains information about the page.