Ler um Consumer

GET

/v1/consumers/{reference}

Um Consumer do ambiente, pelo id (csm_…) ou pelo externalId.

Aceitar os dois é de propósito: o externalId é o que o seu sistema já tem em mãos, e exigir o id obrigaria a guardar um segundo identificador só para consultar.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

reference

obrigatório

string

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

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

Exemplo^gerado

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

401

Chave de API ausente, inválida ou revogada.

404

Não existe Consumer com este id ou externalId no ambiente.

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.