Get all fact find requests for accounts in a circle

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

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/circles/{circle_uuid}/fact-find-requests 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/circles/circle_uuid/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": "a05b086e-8814-4650-8d89-b244b32e5a19",
      "schema": {
        "name": "Default fact-find",
        "uuid": "ef9ec42a-c8f0-4672-a11d-ce7a1907eddf",
        "created_at": "2025-05-02T14:06:28+01:00",
        "public_url": "https://plannr.valet/fact-find/1f66184f-c346-4d18-91ca-463a248c440a",
        "updated_at": "2025-05-02T14:06:28+01:00",
        "archived_at": "2025-05-01T14:06:28+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": "1cdc93f8-d306-4735-81b6-0c9d56b90319",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-05-02T14:06:28+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-05-02T14:06:28+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-05-02T14:06:28+01:00",
      "updated_at": "2025-05-02T14:06:28+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": "050ef43d-a5a7-482f-8be9-82c24ce39294",
        "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": "f96de19f-9155-4d38-98bf-d7550adfd53c"
        },
        "created_at": "2025-05-02T14:06:28+01:00",
        "updated_at": "2025-05-02T14:06:28+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-05-02T14:06:28+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/34b50e00-137c-4313-978b-66b395c45b39/download",
        "last_modified": "2025-05-02T14:06:28+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-05-02T14:06:28+01:00"
      },
      "completed_at": "2025-04-27T14:06:28+01:00",
      "invitation_url": "https://plannr.valet/fact-find/500e8c31-603a-4c40-aadf-d7151bab3112/83e07ce1-32ef-4b64-83e6-f7e2af7ed3c9",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "cf584d3e-5908-4bc1-b3e6-c96b14a077ff"
        },
        "uuid": "bce4ff83-5d80-428d-82fd-0f3b67c7bd5f",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "db6924ad-5e2a-43ee-a3fd-ecf44e134b64"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-05-02T14:06:28+01:00",
        "expires_at": "2025-05-02T14:06:28+01:00",
        "updated_at": "2025-05-02T14:06:28+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}