v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Contacts

List contact attachments

Retrieve a paginated list of attachments (documents) for a specific contact. Each attachment includes a public document URL that can be used directly for download or rendering.

get/v1/contacts/{id}/attachments

Path parameters

idstring uuid required

Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

UUID

Query parameters

limitinteger

Max number of rows returned

pageinteger

Select the page of the result

Headers

api-tokenstring required

API Token

Response

A paginated list of contact attachments

statusinteger

Response status

totalCountinteger

Total items based on current filters

pageinteger

Current page

totalPagesinteger

Total pages based on current filters

hasNextboolean

Indicates that has next page

hasPreviousboolean

Indicates that has previous page

Example response

{
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "contact_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "created_at": "2020-01-01T14:15:00.000000+00:00",
      "updated_at": "2020-01-01T14:15:00.000000+00:00",
      "uploaded_by": {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "first_name": "Maria",
        "last_name": "Silva"
      },
      "document": {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "name": "contract-signed",
        "file_name": "contract-signed.pdf",
        "url": "https://file.clint.digital/.../contract-signed.pdf",
        "extension": "pdf",
        "file_size": 204800
      }
    }
  ]
}