List all fact-find passes for the user

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

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.

      Additional properties are allowed.

    • account object

      The account the fact-find pass is for.

      Additional properties are allowed.

    • circle object

      The circle the fact-find is for.

      Additional properties are allowed.

    • 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/factFindRequest_uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "firm": {
    "name": "Codepotato Ltd",
    "uuid": "57fde56f-a451-4611-8872-f18e93c11f4e"
  },
  "uuid": "24b4f6fe-2226-4079-b5ce-837728f00de7",
  "circle": {
    "name": "The Codepotato Gang",
    "uuid": "8747e3fb-f9a8-4386-9b92-a46d0cb2fec2"
  },
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "e4a0fd62-68b6-49b2-8225-7b8c8b285d52",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-03-10T22:05:26+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-03-10T22:05:26+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "progress": 50,
  "created_at": "2025-03-10T22:05:26+00:00",
  "expires_at": "2025-03-10T22:05:26+00:00",
  "updated_at": "2025-03-10T22:05:26+00:00",
  "is_complete": false,
  "completed_sections": 2
}