Get all document packs

GET /api/v1/document-pack/document-pack

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]

      Additional properties are allowed.
GET /api/v1/document-pack/document-pack 
curl \
 -X GET https://api.plannrcrm.com/api/v1/document-pack/document-pack \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Name of Document Pack",
      "uuid": "c13cf299-bca1-4eb8-9192-ac22bdcdb422",
      "created_at": "2024-12-03T16:50:33+00:00",
      "updated_at": "2024-12-03T16:50:33+00:00",
      "description": "Description of Document Pack",
      "is_template": "Is Document Pack a template"
    }
  ]
}