Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve uma lista paginada das entidades Business da aplicação autenticada.

Quando usar

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

Filtros e paginação

Notas

  • vendor_data pode ser null se a sessão ou a transação de origem não o tiver fornecido.
  • Paginação por cursor: guarde o cursor next entre chamadas.
  • Consulte o modelo de dados Business para ver todos os campos.

Permissões

A função tem de conceder list:businesses.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de consulta

limit
integer
padrão:50

Tamanho da página. A predefinição é 50 quando omitido. Não existe um limite máximo imposto, mas mantenha as páginas pequenas para reduzir a latência.

Intervalo necessário: 1 <= x <= 1000000
offset
integer
padrão:0

Offset de base zero do primeiro registo a devolver. Prefira seguir o URL next da página anterior em vez de calcular este valor manualmente.

Intervalo necessário: 0 <= x <= 1000000

Resposta

Lista paginada de empresas com estado, contagem de sessões e detalhe de funcionalidades.

count
integer

Número de linhas correspondentes — exato até 100, limitado a 100 acima disso por motivos de desempenho. Não o utilize para detetar a última página; em vez disso, confie no facto de next ser null.

next
string | null

URL absoluto da página seguinte, ou null na última página.

previous
string | null

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

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