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": "72235dee-c282-48b4-8cf3-4e7ab9a47451",
      "schema": {
        "name": "Default fact-find",
        "uuid": "18a063eb-e97e-4899-a1f2-a4de0834e289",
        "created_at": "2025-05-22T14:58:00+01:00",
        "public_url": "https://plannr.valet/fact-find/98f32995-d79b-4a58-9859-7ddc09f75202",
        "updated_at": "2025-05-22T14:58:00+01:00",
        "archived_at": "2025-05-21T14:58:00+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": "e44ab5df-aee7-4b06-8295-df15effe0085",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-05-22T14:58:00+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-05-22T14:58:00+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-05-22T14:58:00+01:00",
      "updated_at": "2025-05-22T14:58:00+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": "becda3af-4e5f-4ff2-8d8d-9f9956385b3a",
        "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": "bdb7d061-91cd-48b5-8b78-5b809611e82a"
        },
        "created_at": "2025-05-22T14:58:00+01:00",
        "updated_at": "2025-05-22T14:58:00+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-05-22T14:58:00+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/adaf03af-707a-4a7e-9d47-41a2d29cc5ed/download",
        "last_modified": "2025-05-22T14:58:00+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-05-22T14:58:00+01:00"
      },
      "completed_at": "2025-05-17T14:58:00+01:00",
      "invitation_url": "https://plannr.valet/fact-find/5e3bb8cc-0355-446e-8064-9ae80bf9464a/66ee9973-70d5-4fdf-969c-4a05e9ebd9d7",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "dd3f9682-ed0d-49e5-abef-2323df854143"
        },
        "uuid": "7f92c82c-3815-4c59-8dfa-279f5d857cdd",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "1e36ead2-38cc-438d-97fd-38bf77f23313"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-05-22T14:58:00+01:00",
        "expires_at": "2025-05-22T14:58:00+01:00",
        "updated_at": "2025-05-22T14:58:00+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}