Query parameters

  • 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
    • data array[object]

      Additional properties are allowed.

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": "3c063e7b-3335-4a4e-adaa-85273cc8e35a",
      "schema": {
        "name": "Default fact-find",
        "uuid": "4efef05c-f7f2-468d-9be5-d7e497432888",
        "created_at": "2025-03-10T22:05:27+00:00",
        "public_url": "https://plannr.valet/fact-find/8fd4c1d3-8738-4715-b95d-1e492f04bbbd",
        "updated_at": "2025-03-10T22:05:27+00:00",
        "archived_at": "2025-03-09T22:05:27+00: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": "3a2bd026-d5e6-4a12-b2fb-64826a85a00b",
        "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:27+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-03-10T22:05:27+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-03-10T22:05:27+00:00",
      "updated_at": "2025-03-10T22:05:27+00: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": "b527bad4-7aba-4db0-be80-addb14b588c6",
        "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": "a28b5159-2218-4ea3-aa22-f5cda9f1c2a1"
        },
        "created_at": "2025-03-10T22:05:27+00:00",
        "updated_at": "2025-03-10T22:05:27+00:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-03-10T22:05:27+00:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/17d1c674-b0f1-4125-9890-57a7cbc1d4ad/download",
        "last_modified": "2025-03-10T22:05:27+00:00",
        "documentable_type": "account",
        "original_created_at": "2025-03-10T22:05:27+00:00"
      },
      "completed_at": "2025-03-05T22:05:27+00:00",
      "invitation_url": "https://plannr.valet/fact-find/06ffa992-cedb-4259-9002-96676e2492fd/3a9f54fe-59e0-4255-87c4-91bcbac895ec",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "aad1b538-7b7a-434b-a676-6f4b11c7f322"
        },
        "uuid": "33b477e1-ee56-4127-a840-3d1aa2b6bb0d",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "1064cf0f-67c7-4614-9317-fa6c07318da7"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-03-10T22:05:27+00:00",
        "expires_at": "2025-03-10T22:05:27+00:00",
        "updated_at": "2025-03-10T22:05:27+00:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}