Listar Segmentos

Error

A valid request URL is required to generate request examples

{
  "items": "<unknown>",
  "limit": 10,
  "next_cursor": "eyJpZCI6IjAxOTI...",
  "page": 1,
  "prev_cursor": "eyJpZCI6IjAxOTE..."
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

segments

Error

A valid request URL is required to generate request examples

{
  "items": "<unknown>",
  "limit": 10,
  "next_cursor": "eyJpZCI6IjAxOTI...",
  "page": 1,
  "prev_cursor": "eyJpZCI6IjAxOTE..."
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

organization_id

string

obrigatório

Organization ID (UUID)

ledger_id

string

obrigatório

Ledger ID (UUID)

Parâmetros de consulta

metadata

string

JSON string to filter segments by metadata fields

limit

string

Max items per page (1-100, default 10)

page

string

Page number (default 1)

start_date

string

Filter segments created on/after this date (YYYY-MM-DD)

end_date

string

Filter segments created on/before this date (YYYY-MM-DD)

sort_order

string

Sort direction (asc, desc)

Resposta

items

any

obrigatório

limit

integer<int64>

obrigatório

Exemplo:

10

next_cursor

string

Exemplo:

"eyJpZCI6IjAxOTI..."

page

integer<int64>

Exemplo:

1

prev_cursor

string

Exemplo:

"eyJpZCI6IjAxOTE..."

Primeiros passos

Atual (v2)

Compatibilidade (v1)

Tratamento de erros

Listar Segmentos

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta