GET /api/v1/fact-find-passes/{factFindRequest_uuid}
Personal access token & O auth2

Path parameters

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

    • firm object

      The name of the firm the fact-find pass is for.

      Hide firm attributes Show firm attributes object
      • uuid string
      • name string
    • account object

      The account the fact-find pass is for.

      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
    • circle object

      The circle the fact-find is for.

      Hide circle attributes Show circle attributes object
      • uuid string
      • name string
    • expires_at string

      The expiry date of the fact-find pass. When blank, the fact-find pass will not expire.

    • progress integer

      The progress of the fact-find pass on the fact-find.

    • is_complete boolean

      Determines if the fact-find pass has completed the fact-find.

    • completed_sections integer

      The number of sections the fact-find pass has completed on the fact-find.
GET /api/v1/fact-find-passes/{factFindRequest_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find-passes/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "firm": {
    "name": "Codepotato Ltd",
    "uuid": "219da4ab-5911-4bd7-9f8b-3bfc6b22f191"
  },
  "uuid": "acecb655-282b-4d5d-909f-fb2e1ea03808",
  "circle": {
    "name": "The Codepotato Gang",
    "uuid": "be081568-19ca-4785-97f4-0bda08ad1251"
  },
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "97bfb311-ac99-4ae7-a16b-79a714692d2b",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2026-01-16T13:10:21+00:00",
    "first_name": "Gareth",
    "updated_at": "2026-01-16T13:10:21+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "progress": 50,
  "created_at": "2026-01-16T13:10:21+00:00",
  "expires_at": "2026-01-16T13:10:21+00:00",
  "updated_at": "2026-01-16T13:10:21+00:00",
  "is_complete": false,
  "completed_sections": 2
}