List Deal Documents

curl --request GET \
  --url https://api.example.com/v1/deals/{id}/documents

{
  "data": {
    "documents": [
      {
        "id": "<string>",
        "name": "<string>",
        "mime_type": "<string>",
        "size_bytes": 123,
        "folder": "<string>",
        "tags": [
          {}
        ],
        "role": "<string>",
        "linked_at": "<string>",
        "created_at": "<string>"
      }
    ]
  },
  "meta": {}
}

GET

deals

{id}

documents

List Deal Documents

curl --request GET \
  --url https://api.example.com/v1/deals/{id}/documents

{
  "data": {
    "documents": [
      {
        "id": "<string>",
        "name": "<string>",
        "mime_type": "<string>",
        "size_bytes": 123,
        "folder": "<string>",
        "tags": [
          {}
        ],
        "role": "<string>",
        "linked_at": "<string>",
        "created_at": "<string>"
      }
    ]
  },
  "meta": {}
}

Request

Path Parameters

string

required

Deal UUID.

Query Parameters

page

integer

default:"1"

Page number.

per_page

integer

default:"25"

Results per page. Maximum 100.

role

string

Filter to documents linked with a specific relationship role.

Headers

Authorization: Bearer wbk_your_api_key_here

Response

data

object

Show properties

documents

array

Show Document object

string

Document UUID

name

string

Display name

mime_type

string

MIME type

size_bytes

integer

File size

folder

string

Folder path

Example Response

{
  "data": {
    "documents": [
      {
        "id": "doc_02HY2",
        "name": "Acme-SPA-draft-v3.pdf",
        "mime_type": "application/pdf",
        "size_bytes": 512400,
        "folder": "/clients/acme/spa",
        "tags": ["spa", "draft"],
        "role": "draft",
        "linked_at": "2026-04-16T13:00:00Z",
        "created_at": "2026-04-16T13:00:00Z"
      }
    ]
  },
  "meta": { "page": 1, "per_page": 25, "total": 3 }
}

Errors

Status	Code	Description
401	`invalid_key`	Invalid or expired API key
403	`insufficient_permissions`	Missing `read:documents` permission
404	`not_found`	Deal not found
429	`rate_limited`	Rate limit exceeded

List Contact Documents Import Contacts

​Request

​Path Parameters

​Query Parameters

​Headers

​Response

​Example Response

​Errors

Request

Path Parameters

Query Parameters

Headers

Response

Example Response

Errors