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

        The UUID of the resource.

      • created_at string

        The timestamp of when the resource was created.

      • updated_at string

        The timestamp of when the resource was updated.

      • archived_at string

        If the schema has been archived, the datetime of when it was archived.

      • is_archived boolean

        Denotes if the schema has been archived.

      • name string

        The name of the fact-find schema.

      • introduction_html string

        The name of the fact-find schema. Must be unique.

      • sections_count integer

        The number of sections inside of a fact-find schema.

      • public_url string

        The public URL of the fact-find schema.
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": "fd4a8232-5f72-4194-97e8-c3be3603d093",
      "created_at": "2025-12-24T11:02:59+00:00",
      "public_url": "https://api.plannrcrm.com/fact-find/76940364-4990-4a1e-a30c-8e23ce88f67b",
      "updated_at": "2025-12-24T11:02:59+00:00",
      "archived_at": "2025-12-23T11:02:59+00:00",
      "is_archived": false,
      "sections_count": 5,
      "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
    }
  ]
}