Get all fact-find schemas

GET /api/v1/fact-find/schema

Headers

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]
  
  Additional properties are allowed.

GET /api/v1/fact-find/schema

curl \
 -X GET https://api.plannrcrm.com/api/v1/fact-find/schema \
 -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": "Default fact-find",
      "uuid": "6acd2ccf-a172-4de4-a24e-d4af5ba6ae2a",
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+00:00",
      "archived_at": "2024-11-19T13:24:03+00:00",
      "is_archived": false,
      "sections_count": 5,
      "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
    }
  ]
}