Get all sections for a fact-find schema

GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • factFindSchema_uuid string Required

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name, position]. Negative sign to denote DESC. Defaults to 'position'.

  • 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
      • name string
      • front_end_section string
      • introduction_html string
      • position integer
GET /api/v1/fact-find/schema/{factFindSchema_uuid}/section
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/schema/6ff8f7f6-1eb3-3525-be4a-3932c805afed/section' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": [
    {
      "name": "Basic Details",
      "uuid": "e51d81a3-6d98-472b-97fe-b1db8ce76af6",
      "position": 1,
      "created_at": "2025-06-26T11:37:09+01:00",
      "updated_at": "2025-06-26T11:37:09+01:00",
      "front_end_section": "basic_details",
      "introduction_html": "<p>Please tell us your <b>basic details.</b></p>"
    }
  ]
}