GET /api/v1/document-pack/document-pack
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[name] string

    Filter by name. This is a fuzzy search.

  • filter[is_template] boolean

    Filter document packs that are templates

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name, is_template]. Negative sign to denote DESC. Defaults to 'name'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • description string
      • is_template string
GET /api/v1/document-pack/document-pack 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/document-pack/document-pack' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    [
      {
        "name": "Name of Document Pack",
        "uuid": "4c0f5d8c-2e94-44d7-b07d-ebee86541f0b",
        "created_at": "2025-12-24T11:02:59+00:00",
        "updated_at": "2025-12-24T11:02:59+00:00",
        "description": "Description of Document Pack",
        "is_template": "Is Document Pack a template"
      }
    ]
  ]
}