Listar Consumers

GET

/v1/consumers

Os Consumers do ambiente, do mais novo para o mais antigo, em páginas.

Quando há mais, nextCursor vem preenchido: repita a chamada passando esse valor em cursor. Quando é a última página, nextCursor vem nulo.

Autorização

• Bearer

Parâmetros

Parâmetros de consulta

limit

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

Itens por página, de 1 a 100. O padrão é 50.

cursor

string

O nextCursor da página anterior.

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

items

obrigatório

Array<object>

object

id

obrigatório

string

externalId

obrigatório

string

name

obrigatório

string

metadata

obrigatório

null | object

createdAt

obrigatório

string formato: date-time

nextCursor

obrigatório

null | string

Exemplo^gerado

{
  "items": [
    {
      "id": "example",
      "externalId": "example",
      "name": "example",
      "metadata": "example",
      "createdAt": "2026-04-15T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

401

Chave de API ausente, inválida ou revogada.

422

Pedido inválido. O motivo vem em title.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.