Create a fact-find request Run in API Explorer

POST /api/v1/fact-find/request
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body Required

  • fact_find_schema_uuid string Required

    The UUID of the fact-find schema that you would like the client to use.

  • client_uuid string Required

    The UUID of the client account to send the fact-find request. This must only be individual clients. Cannot be used with circle_uuid.

  • circle_uuid string Required

    The UUID of the circle to send the fact-find request to. Cannot be used with client_uuid.

  • send_invitation_email boolean

    This controls if an email to the client is sent to invite them to complete a fact-find. Set this to false if you are going to send your own invitation.

  • invitation_text string

    The text that will appear in the invitation email sent to the client (if enabled)

Responses

  • 201 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.

    • status string

      The status of the fact-find request. Available options: in_progress,complete

    • completed_at string

      The datetime when the fact-find request has been completed

    • invitation_text string

      The text that is used in the notification/email sent out to the client.

    • schema object

      The fact-find schema used for the fact-find request.

      Hide schema attributes Show schema attributes object
      • uuid string
      • created_at string
      • updated_at string
      • archived_at string
      • is_archived boolean
      • name string
      • introduction_html string
      • sections_count integer
      • public_url string
    • latest_file object

      The latest file that has been generated for the fact-find request.

      Hide latest_file attributes Show latest_file attributes object
      • uuid string
      • created_at string
      • original_created_at string
      • updated_at string
      • uploaded_at string
      • status string
      • filename string
      • name string
      • extension string
      • type string
      • size string
      • path string
      • last_modified string
      • progress string
      • download_url string
      • folder_name string
      • folder string
      • documentable_type string
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object
        • model_type string
        • model_uuid string
      • firm string
      • account string
      • tags string
    • account object

      The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.

      Hide account attributes Show account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.

      Hide fact_find_passes attributes Show fact_find_passes attributes object
      • uuid string
      • created_at string
      • updated_at string
      • firm object
        Hide firm attributes Show firm attributes object
        • uuid string
        • name string
      • account string
      • circle object
        Hide circle attributes Show circle attributes object
        • uuid string
        • name string
      • expires_at string
      • progress integer
      • is_complete boolean
      • completed_sections integer
POST /api/v1/fact-find/request 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/request' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"fact_find_schema_uuid":"bac0df4e-996d-4de7-bfa8-f14e9587bd73","client_uuid":"6c5e47c6-4faf-4fab-a2a8-e6159a70955b","circle_uuid":"e5d6d3d1-550c-4a2f-a35b-9f02f54919de","send_invitation_email":true,"invitation_text":"Please complete this fact-find."}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "fact_find_schema_uuid": "bac0df4e-996d-4de7-bfa8-f14e9587bd73",
  "client_uuid": "6c5e47c6-4faf-4fab-a2a8-e6159a70955b",
  "circle_uuid": "e5d6d3d1-550c-4a2f-a35b-9f02f54919de",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact-find."
}
Response examples (201) 
{
  "uuid": "3a5930ec-cd2c-4d30-9277-d98e9ea00c2f",
  "schema": {
    "name": "Default fact-find",
    "uuid": "588d4681-9843-48a1-a867-337db154768d",
    "created_at": "2025-11-18T19:51:11+00:00",
    "public_url": "https://api.plannrcrm.com/fact-find/22a66b6c-092f-4967-969c-c57f1d9853f4",
    "updated_at": "2025-11-18T19:51:11+00:00",
    "archived_at": "2025-11-17T19:51:11+00:00",
    "is_archived": false,
    "sections_count": 5,
    "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
  },
  "status": "complete",
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "d1608a40-38fc-4645-8d4b-5709d6551dfb",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-11-18T19:51:11+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-18T19:51:11+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-11-18T19:51:11+00:00",
  "updated_at": "2025-11-18T19:51:11+00:00",
  "latest_file": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Welcome to Plannr",
    "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
    "size": "21691783",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "type",
    "uuid": "de5fe893-1c9c-4ad7-ad2f-5d1acc019bbe",
    "folder": "App\\Http\\Resources\\FolderResource",
    "status": "uploaded",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "filename": "Welcome to Plannr.pdf",
    "progress": "100",
    "extension": "pdf",
    "navigator": {
      "model_type": "account",
      "model_uuid": "923d0d67-9148-463f-b5c7-d1bb7f39c7c6"
    },
    "created_at": "2025-11-18T19:51:11+00:00",
    "updated_at": "2025-11-18T19:51:11+00:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-11-18T19:51:11+00:00",
    "documentable": "Object",
    "download_url": "https://api.plannrcrm.com/file/fd061d57-d016-43f5-b0d7-2307061cb254/download",
    "last_modified": "2025-11-18T19:51:11+00:00",
    "documentable_type": "account",
    "original_created_at": "2025-11-18T19:51:11+00:00"
  },
  "completed_at": "2025-11-13T19:51:11+00:00",
  "invitation_url": "https://api.plannrcrm.com/fact-find/8174b9ec-d5b7-4e7d-b392-a7f7c36dabb6/9c05f9f6-bad7-40b2-8514-e0b42b56cce0",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "d43f93e2-4224-4a30-82da-f5d34a7834b6"
    },
    "uuid": "c6c331e6-58c3-425a-a1de-d12ed7536144",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "701f7856-2281-4ad7-be76-c3bb82ae8416"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-11-18T19:51:11+00:00",
    "expires_at": "2025-11-18T19:51:11+00:00",
    "updated_at": "2025-11-18T19:51:11+00:00",
    "is_complete": false,
    "completed_sections": 2
  }
}