Consultar Vendedores

Consultar Vendedores

Recipes
🔀
🔀 Realizando uma venda com Split de Pagamento
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Paginação e filtros

Todos os query params são opcionais. A consulta retorna os vendedores da empresa autenticada. Os padrões são page=1, size=10, sort=created_at e dir=desc.

As buscas por nome e razão social não distinguem maiúsculas e minúsculas. uuid, status e document_type usam correspondência exata. Os enums listam valores conhecidos; valores desconhecidos não têm rejeição por enum garantida.

Datas

  • Formatos aceitos: YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss, YYYY-MM-DD HH:mm:ss e RFC 3339 com Z ou offset.
  • Sem offset, a interpretação inicial é UTC. Datas sem horário representam meia-noite; o limite final não se estende ao fim do dia.
  • Os filtros usam a data interpretada sem acrescentar horas. Registros exatamente nos limites também entram no resultado.
  • Datas inválidas podem ser ignoradas, sem erro de validação garantido.

Aliases de compatibilidade

Prefira os nomes canônicos. Uma data canônica válida tem prioridade sobre os aliases.

CampoAliases
created_at_startcreateDateStart, create_date_start
created_at_endcreateDateEnd, create_date_end
updated_at_startupdateDateStart, update_date_start
updated_at_endupdateDateEnd, update_date_end

Sem uma data canônica válida, a consulta tenta o alias camelCase antes do alias snake_case.

Query Params
string

Filtrar por UUID do vendedor.

string
enum

Filtrar pelo status do vendedor.

Allowed:
string

Buscar nomes que contenham o texto informado.

string
enum

Filtrar pelo tipo de documento do vendedor.

Allowed:
string

Buscar documentos que contenham o número informado. Pontos, hífens e barras são desconsiderados.

boolean

Filtrar vendedores principais (true) ou não principais (false).

string

Filtrar vendedores criados a partir da data informada, incluindo o limite.

string

Filtrar vendedores criados até a data informada, incluindo o limite.

string

Filtrar atualizações a partir da data informada, incluindo o limite.

string

Filtrar atualizações até a data informada, incluindo o limite.

integer
Defaults to 1

Número da página. Valores menores que 1 utilizam a página 1.

integer
Defaults to 10

Registros por página: de 10 a 200. Valores fora dessa faixa utilizam 10.

string
enum
Defaults to created_at

Campo de ordenação. Valores desconhecidos utilizam created_at.

Allowed:
string
enum
Defaults to desc

Direção da ordenação. Só é considerada quando sort é enviado; apenas asc altera o padrão desc.

Allowed:
Headers
string
required

chave da Api

Responses

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