Pular para o conteúdo principal
GET
curl
O endpoint Obter uma execução de sincronização da Didit retorna uma sincronização com o resultado de cada conta e recurso: as contagens de itens adicionados, modificados e removidos, ou o erro. O sync_id vem de Atualizar uma conexão ou do webhook bank.data.updated.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, obtida em Developers -> API keys no Business Console. A chave principal tem acesso completo. Uma chave nomeada pode ter escopo limitado: nenhum, leitura ou escrita por recurso, restrita a alguns fluxos ou a sessões aprovadas, a uma lista de endereços 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 a requisição partiu de um endereço fora da lista de endereços da chave; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status permitidos para a chave. Uma chave sem acesso a mídia recebe as URLs de imagem, vídeo e PDF como null, e uma chave sem escrita de sessões recebe os links e tokens de sessão como null. Veja https://docs.didit.me/console/api-keys.

Parâmetros de caminho

id
string<uuid>
obrigatório

O ID da conexão.

sync_id
string<uuid>
obrigatório

O id da execução de sincronização.

Resposta

A execução de sincronização.

Uma sincronização de uma conexão. Somente sincronizações iniciais, agendadas e solicitadas são listadas.

id
string<uuid>
obrigatório
connection_id
string<uuid>
obrigatório
trigger
enum<string>
obrigatório
Opções disponíveis:
initial,
scheduled,
requested
status
enum<string>
obrigatório
Opções disponíveis:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
obrigatório
finished_at
string<date-time> | null
obrigatório
results
object[]
obrigatório

O que a execução fez, por conta e por recurso.

error
object | null
obrigatório

Por que a execução falhou como um todo. null quando não falhou. Os erros de contas e recursos individuais estão em results.

Última modificação em 22 de novembro de 2026