List Segments

Your saved segments, most recently changed first. A segment is a named list of people (phone and/or email, optional attributes) you can send campaigns to as often as you like.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Query Params

Filter by name (contains, case-insensitive).

number
Defaults to 25

Page size (1–100).

number
Defaults to 0

Rows to skip.

Responses

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

429

Too many requests

503

Segments are not available yet on this server

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