Get all fact-find schemas

GET /api/v1/fact-find/schema

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[archived] string

Filter archived fact-find schemas. E.g filter[archived]=include, filter[archived]=exclude, filter[archived]=only
sort string

Field to sort by. Valid fields are [created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'created_at'.
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
  
  archived_at string
  
  is_archived boolean
  
  name string
  
  introduction_html string
  
  sections_count integer
  
  public_url string

GET /api/v1/fact-find/schema

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/schema' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Default fact-find",
      "uuid": "b0b82f30-45b5-4bfe-b6a5-d9b0f2a77303",
      "created_at": "2025-06-26T11:37:09+01:00",
      "public_url": "https://api.plannrcrm.com/fact-find/b5d9ec38-86b7-460c-89ae-7eefeaf975f8",
      "updated_at": "2025-06-26T11:37:09+01:00",
      "archived_at": "2025-06-25T11:37:09+01:00",
      "is_archived": false,
      "sections_count": 5,
      "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
    }
  ]
}