Files (Documents)

List files

Filtered request example — Documents on one deal whose name contains proposal:

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/documents.json?conditions[document_deal_id]=4521&conditions[document_name]=proposal&per_page=50"
get/documents

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/documents
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Query parameters

sortstring

The attribute to sort on

associated_with'all' | 'companies' | 'deals' | 'email' | 'people' | 'shared'

Returns records with given association

document_associationstring

Documents whose primary association is one of the given records, each written as <name>:<Type>:<id> (the name is ignored), for example Acme:Company:3310.

document_namestring

Returns records with name like documents_name

document_ownerinteger

Returns records owned by document owner (defaults to current user)

document_primary_association_namestring

Returns records that match a LIKE query on the primary association name

document_shared'Yes' | 'No'

Returns records that are shared or not

document_type'all' | 'spreadsheets' | 'images' | 'documents' | 'pds' | 'presentations' | 'others'

Returns records with given document_type

status'complete' | 'incomplete'

Upload state: complete (the file has been received) or incomplete (the upload was started but never finished).

Filters as bracketed query parameters, for example ?conditions[document_deal_id]=4521&conditions[document_type]=pdf. Each key below is one filter; see the Filtering guide for the value formats (ids, lists, date ranges, number ranges, custom fields) and the example above for a complete request.

{
  "document_association": "Acme Corporation:Company:3310",
  "document_modified": "last_30",
  "document_uploaded": {
    "from_date": "2012/02/07 15:26:10 -0500",
    "to_date": "2012/02/07 15:26:10 -0500"
  },
  "status": "complete"
}
calendar_entry_idinteger

Filter documents by calendar entry ID (task or event)

Response

Successful Response

Example response

{
  "entries": [
    {
      "id": 7710,
      "created_at": "2026-09-01 14:22:07",
      "size_in_k": 102,
      "owner": {
        "id": 13,
        "full_name": "Sam Okafor"
      },
      "person": {
        "id": 8802,
        "full_name": "Jane Rivera"
      },
      "deal": {
        "id": 4521,
        "name": "Acme Corporation - Q4 renewal"
      },
      "company": {
        "id": 3310,
        "name": "Acme Corporation"
      },
      "calendar_entry": {
        "id": 5602,
        "name": "Kickoff call with Acme"
      },
      "etag": "edd88e4bfa45c14de553c40d17c8f504",
      "upload_status": 2,
      "upload_status_error_message": "The server returned 404 Not Found",
      "upload_state": "pending",
      "document_tag_ids": [
        123,
        124
      ],
      "document_tags": [
        {
          "id": 5,
          "name": "Contract"
        }
      ],
      "public_link": "https://pipelinedeals.s3.amazonaws.com/document.txt",
      "updated_at": "2026-09-01 14:22:07",
      "title": "Acme-renewal-quote-v2.pdf",
      "owner_id": 123,
      "person_id": 123,
      "deal_id": 123,
      "company_id": 123,
      "calendar_entry_id": 123,
      "primary_association_id": 123,
      "primary_association_type": "CalendarTask",
      "url": "https://app.pipelinecrm.com/documents/7710"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 200,
    "total": 670,
    "pages": 4,
    "total_in_account": 1204,
    "page_var": "page",
    "url": "/api/v3/deals.json"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.