Get a fact-find schema

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

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

factFindSchema_uuid string Required

Responses

200 application/json
Hide response attributes Show response 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/{factFindSchema_uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/schema/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "name": "Default fact-find",
  "uuid": "fd30f60e-b281-49d7-898c-83374fe02352",
  "created_at": "2025-08-07T13:41:45+01:00",
  "public_url": "https://api.plannrcrm.com/fact-find/0cc67b85-d22e-499a-b3c5-2d3dba348655",
  "updated_at": "2025-08-07T13:41:45+01:00",
  "archived_at": "2025-08-06T13:41:45+01:00",
  "is_archived": false,
  "sections_count": 5,
  "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
}