v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar arquivos

get/files

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

hash da proxíma página

user_idinteger

Filtrar pelo ID do usuário responsável pelo arquivo.

deal_idinteger

Filtrar pelo ID da oportunidade de vínculo com o arquivo.

email_idinteger

Filtrar pelo ID do email de vínculo do arquivo.

call_idinteger

Filtrar pelo ID da ligação de vínculo com o arquivo.

namestring

Filtrar pelo nome do arquivo.

formatstring

Filtrar pelo formato do arquivo.

hashstring

Filtrar pela hash do arquivo.

idinteger

Filtrar pelo ID do arquivo.

created_at_startstring date-time

Filtrar por arquivos criados a partir da data informada

created_at_endstring date-time

Filtrar por arquivos criados até a data informada

updated_at_startstring date-time

Filtrar arquivos atualizados a partir da data informada.

updated_at_endstring date-time

Filtrar arquivos atualizados até a data informada.

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": [
    {
      "id": 123,
      "account_id": 123,
      "user_id": 123,
      "deal_id": 123,
      "email_id": 123,
      "template_email_id": 123,
      "call_id": 123,
      "name": "NOME DO ARQUIVO.pdf",
      "url": "https://api.pipe.run/v1/files/.../download",
      "url_resource": "https://assets.pipe.run/account/.../w4os84ok4c.pdf",
      "format": "pdf",
      "description": "Documento gerado através de um modelo de documento",
      "size": 123,
      "hash": "njq....ow",
      "created_at": "2025-07-09 10:27:02"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6MzkwO...6dHJ1ZX0"
    }
  }
}
All 220 operations