Saltar para o conteúdo principal
GET
curl
Lista os casos da aplicação, do mais recente para o mais antigo por predefinição. Todos os filtros e opções de ordenação disponíveis na lista de casos da Consola são expostos como parâmetros de consulta, incluindo o parâmetro search para pesquisa de texto integral sobre o titular, as etiquetas, o número do caso e os IDs de sessão ou de transação associados. Cada caso inclui também a team responsável, o checker nomeado de uma resolução de dupla validação pendente, e o country e o portrait do titular.

Acesso

Os endpoints de casos requerem uma chave de API com acesso total. Um pedido efetuado com uma chave de API com acesso restrito devolve 403.

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 caminho

organization_id
string<uuid>
obrigatório

UUID da organização.

application_id
string<uuid>
obrigatório

UUID da aplicação.

Parâmetros de consulta

limit
integer
padrão:50

Tamanho da página. A predefinição é 50.

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

Offset de base zero do primeiro registo.

Intervalo necessário: x >= 0
status__in
string

Estados a incluir separados por vírgulas, por exemplo, OPEN,AWAITING_USER.

priority
string

Prioridades a incluir separadas por vírgulas.

source__in
string

Origens a incluir separadas por vírgulas.

blueprint
string<uuid>

Filtrar para casos neste blueprint.

assigned_to
string<uuid>

Filtrar para casos atribuídos a este utilizador.

unassigned
boolean

true para casos não atribuídos, false para casos atribuídos.

tag
string

Filtrar para casos que tenham exatamente esta etiqueta.

Corresponde ao título, número do caso, etiqueta, nome/UUID/ID externo do sujeito, UUID da sessão associada ou UUID da transação associada.

date_from
string<date>

Limite inferior da data de criação (inclusivo).

date_to
string<date>

Limite superior da data de criação (inclusivo).

due_before
string<date-time>

Limite superior de due_at.

overdue
boolean

true para devolver apenas casos em atraso que estejam abertos ou a aguardar utilizador.

ordering
enum<string>
padrão:-created_at

Ordem de ordenação. due_at ordena os nulos no final.

Opções disponíveis:
created_at,
-created_at,
due_at,
-due_at

Resposta

200 - application/json

Lista paginada de casos.

count
integer

Número de linhas correspondentes. Exato até 100, limitado a 100 acima desse valor por motivos de desempenho. Confie que next é null para detetar a última página.

next
string | null

URL absoluto da página seguinte, ou null.

previous
string | null

URL absoluto da página anterior, ou null.

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