Skip to main content
GET
/
v1
/
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

​
id
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
​
meta
object
Pagination metadata: page, per_page, total.
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID. 
curl "https://data.leadlex.com/functions/v1/api-gateway/v1/deals/deal_01HY1/documents" \
  -H "Authorization: Bearer wbk_your_api_key_here"

​
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

StatusCodeDescription
401invalid_keyInvalid or expired API key
403insufficient_permissionsMissing read:documents permission
404not_foundDeal not found
429rate_limitedRate limit exceeded