Skip to main content
GET
List Segments

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

page
integer
Required range: x >= 1
type
enum<string>
required

Segment type to operate on

Available options:
customer,
product
page_size
integer
Required range: 1 <= x <= 100
sort_by
enum<string>
default:updated_at
Available options:
created_at,
updated_at,
name
sort
enum<string>
default:desc
Available options:
asc,
desc

Response

Paginated list of segments

data
object[]
pagination
object