List all fact-find passes for the user

GET /api/v1/fact-find-passes/{factFindRequest_uuid}

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": "7a6c60b4-e458-4d9c-8538-1d8aafcfc212"
  },
  "uuid": "e88d9540-7194-48db-bc4b-667018986e72",
  "circle": {
    "name": "The Codepotato Gang",
    "uuid": "e06f1d2a-e2ec-4592-87d9-9cdd9d9309fd"
  },
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "284b3f86-c7f5-4a12-9543-f7bc25c90c08",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-06-26T11:37:01+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:01+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "progress": 50,
  "created_at": "2025-06-26T11:37:01+01:00",
  "expires_at": "2025-06-26T11:37:01+01:00",
  "updated_at": "2025-06-26T11:37:01+01:00",
  "is_complete": false,
  "completed_sections": 2
}