Get all fact-find requests the client owns.

GET /api/v1/client/{client_id}/fact-find/requests
Personal access token & O auth2

Path parameters

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'created_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/client/{client_id}/fact-find/requests 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/client_id/fact-find/requests' \
 --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) 
{
  "data": [
    {
      "uuid": "deb0860b-0195-4eb3-96e3-eae248dd19bc",
      "schema": {
        "name": "Default fact-find",
        "uuid": "3b2436f7-5193-4e05-8ad6-e5a4ce6749d1",
        "created_at": "2025-04-02T13:27:55+01:00",
        "public_url": "https://plannr.valet/fact-find/8667e4e5-ed50-4694-958b-9fe6a0d0f0d0",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "archived_at": "2025-04-01T13:27:55+01: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": "b5fd9e55-1f17-4fb5-b7df-7006a7ce8f2d",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-04-02T13:27:55+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-04-02T13:27:55+01:00",
      "updated_at": "2025-04-02T13:27:55+01: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": "c158ad50-cdfe-4a3e-9a75-17ebc2feabca",
        "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": "51aa13bb-6996-47d6-820c-92f9ff47c5bd"
        },
        "created_at": "2025-04-02T13:27:55+01:00",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-04-02T13:27:55+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/9a0bd690-3c28-4239-8814-afabc9b2cb84/download",
        "last_modified": "2025-04-02T13:27:55+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-04-02T13:27:55+01:00"
      },
      "completed_at": "2025-03-28T13:27:55+00:00",
      "invitation_url": "https://plannr.valet/fact-find/b1fd6209-3afb-4b98-b7e7-2e834c775bc6/ec4fb938-3f7e-48ab-ac84-236ad3da047d",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "c083ff3b-831b-445e-a175-d53543eef91a"
        },
        "uuid": "bc9827f0-1267-4b26-a841-99c0d3995327",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "2709603a-f852-4d51-91cd-a4209924cded"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-04-02T13:27:55+01:00",
        "expires_at": "2025-04-02T13:27:55+01:00",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}