Pular para o conteúdo principal
GET
curl

Visão geral

Retorna uma lista paginada de entidades empresariais da aplicação autenticada.

Quando usar

  • Sincronize sua tabela de empresas com uma ferramenta externa de BI ou um data warehouse.
  • Filas para analistas: filtre por status=FLAGGED para alimentar uma caixa de entrada para revisão.
  • Pesquisar por display_name, legal_name, registration_number ou vendor_data.

Filtros e paginação

Observações

  • vendor_data pode ser null se a sessão ou transação de origem não tiver fornecido um.
  • A paginação é baseada em cursor: guarde o cursor next entre as chamadas.
  • Consulte o modelo de dados de empresa para ver todos os campos.

Permissões

A função deve conceder list:businesses.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de consulta

limit
integer
padrão:50

Tamanho da página. O padrão é 50 quando omitido. Não há máximo imposto, mas mantenha as páginas pequenas para reduzir a latência.

Intervalo obrigatório: 1 <= x <= 1000000
offset
integer
padrão:0

Deslocamento, a partir de zero, do primeiro registro a retornar. Prefira seguir a URL next da página anterior em vez de calcular este valor manualmente.

Intervalo obrigatório: 0 <= x <= 1000000

Resposta

Lista paginada de empresas com status, contagem de sessões e detalhamento por recurso.

count
integer

Número de linhas correspondentes: exato até 100 e limitado a 100 acima disso, por desempenho. Não o use para detectar a última página; considere next igual a null.

next
string | null

URL absoluta da próxima página, ou null na última página.

previous
string | null

URL absoluta da página anterior, ou null na primeira página.

results
object[]
Última modificação em 1 de novembro de 2026