API ADVBOXObtenha uma lista de documentos
Última atualização em
Retorna os documentos (arquivos anexados) da conta, filtrados por nome, cliente, lançamento financeiro ou tarefa.
Filtros (pelo menos 1 é obrigatório):
name- Busca parcial pelo nome do arquivo (case-insensitive, mínimo 3 caracteres; inclui a extensão)customer_id- ID do clientetransaction_id- ID do lançamento financeiro (o anexo retorna comattached_to.type=financial)post_id- ID da tarefa
Múltiplos filtros são combinados com AND. Um filtro por id inexistente retorna totalCount: 0 (não é erro).
Cada item traz links.download, usado no endpoint de download para gerar a URL temporária do arquivo.
Authorization
BearerAuth In: header
Query Parameters
[Optional] Busca parcial pelo nome do arquivo. Case-insensitive, mínimo 3 caracteres, inclui a extensão. Pelo menos um filtro é obrigatório.
3 <= length[Optional] ID exato do cliente ao qual o arquivo está anexado. Pelo menos um filtro é obrigatório.
[Optional] ID exato do lançamento financeiro ao qual o arquivo está anexado. Pelo menos um filtro é obrigatório.
[Optional] ID exato da tarefa à qual o arquivo está anexado. Pelo menos um filtro é obrigatório.
[Optional] Número de registros por página. Aceita de 1 a 1000; valores acima são reduzidos a 1000. Padrão: 1000.
10001 <= value <= 1000[Optional] Número de registros a pular para paginação (padrão: 0).
00 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://app.advbox.com.br/api/v1/documents"{
"offset": 0,
"limit": 1000,
"totalCount": 1,
"data": [
{
"id": 12345678,
"name": "peticao_inicial.pdf",
"size": "115.3 KB",
"links": {
"download": "/api/v1/documents/12345678/download"
},
"attached_to": {
"type": "task",
"id": 123456789,
"label": "COMENTÁRIO"
},
"uploaded_at": "2024-01-15 12:00:00"
}
],
"query": {
"post_id": "123456789",
"name": null
}
}{
"error": "Unauthenticated."
}{
"message": "The given data was invalid.",
"errors": {
"name": [
"At least one filter must be provided."
]
}
}