Get a fact-find schema

GET /api/v1/fact-find/schema/{factFindSchema_uuid}
Personal access token & OAuth2

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.
GET /api/v1/fact-find/schema/{factFindSchema_uuid} 
curl \
 --request GET https://api.plannrcrm.com/api/v1/fact-find/schema/factFindSchema_uuid \
 --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) 
{
  "name": "Default fact-find",
  "uuid": "6190e98f-efac-4b1e-975c-e8d842abe105",
  "created_at": "2025-02-20T10:13:05+00:00",
  "updated_at": "2025-02-20T10:13:05+00:00",
  "archived_at": "2025-02-19T10:13:05+00:00",
  "is_archived": false,
  "sections_count": 5,
  "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
}