Get all fact-find schemas

GET /api/v1/fact-find/schema
Personal access token & O auth2

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
GET /api/v1/fact-find/schema 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/schema' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Default fact-find",
      "uuid": "2b93dce2-418d-417a-9a80-0239d6be18b1",
      "created_at": "2025-04-02T13:27:58+01:00",
      "public_url": "https://plannr.valet/fact-find/21bdb3ca-aa4d-43d9-8dfd-b223f4d71297",
      "updated_at": "2025-04-02T13:27:58+01:00",
      "archived_at": "2025-04-01T13:27:58+01:00",
      "is_archived": false,
      "sections_count": 5,
      "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
    }
  ]
}