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": "87680a3d-92da-4d24-a376-688c668792b4",
      "schema": {
        "name": "Default fact-find",
        "uuid": "0d528fd5-21b3-4925-bce5-7194cc1520ab",
        "created_at": "2025-04-11T12:54:59+01:00",
        "public_url": "https://plannr.valet/fact-find/6ef86299-b9d0-4187-9ebf-aef2308fb4d4",
        "updated_at": "2025-04-11T12:54:59+01:00",
        "archived_at": "2025-04-10T12:54:59+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": "83e8276e-ea17-44c9-8572-5f729812b673",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-04-11T12:54:59+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-11T12:54:59+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-04-11T12:54:59+01:00",
      "updated_at": "2025-04-11T12:54:59+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": "9fff9c6d-09bb-4a89-9055-12f7d5f0070e",
        "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": "ac9a5a15-8d2f-4475-8f57-09b1a10806d3"
        },
        "created_at": "2025-04-11T12:54:59+01:00",
        "updated_at": "2025-04-11T12:54:59+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-04-11T12:54:59+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/ab14624f-e493-4e89-8ae6-43d9388e78fc/download",
        "last_modified": "2025-04-11T12:54:59+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-04-11T12:54:59+01:00"
      },
      "completed_at": "2025-04-06T12:54:59+01:00",
      "invitation_url": "https://plannr.valet/fact-find/eeb58f3d-76f9-4b1e-95f8-e10d27a67fdb/6c13915f-682b-4109-94c5-6348e6784f62",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "7947b182-c51d-4f73-8da8-96198034c83b"
        },
        "uuid": "e4eab14a-04d3-4434-be31-141984ce2eec",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "7043167d-2484-4863-9489-0af96d7490b2"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-04-11T12:54:59+01:00",
        "expires_at": "2025-04-11T12:54:59+01:00",
        "updated_at": "2025-04-11T12:54:59+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}