Get all fact-find requests for the user.

GET /api/v1/fact-find/request
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/fact-find/request 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/request' \
 --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": "6c1550ed-9f25-4f1e-addb-40b2d4e37c9c",
      "schema": {
        "name": "Default fact-find",
        "uuid": "79f9737b-d737-4c96-935d-326204a169c6",
        "created_at": "2025-04-02T13:27:58+01:00",
        "public_url": "https://plannr.valet/fact-find/a68f6220-3872-4a1f-b21d-53dd56ab638d",
        "updated_at": "2025-04-02T13:27:58+01:00",
        "archived_at": "2025-04-01T13:27:58+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": "b0f9f022-46f0-4ed2-9051-c98a2c142cb2",
        "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:58+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-02T13:27:58+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-04-02T13:27:58+01:00",
      "updated_at": "2025-04-02T13:27:58+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": "773768aa-48d1-4742-8574-b00417eb6859",
        "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": "364f49ef-0d06-4907-822a-189ec8dde810"
        },
        "created_at": "2025-04-02T13:27:58+01:00",
        "updated_at": "2025-04-02T13:27:58+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-04-02T13:27:58+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/d0256e0e-cae9-483c-a390-2a7f1e216903/download",
        "last_modified": "2025-04-02T13:27:58+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-04-02T13:27:58+01:00"
      },
      "completed_at": "2025-03-28T13:27:58+00:00",
      "invitation_url": "https://plannr.valet/fact-find/d670bb5e-ae36-4fc2-913c-d20839f818a8/8db7b89a-2b4e-4aa3-83c9-44d43cb9ae7a",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "6f70d77b-caa9-4a1c-a021-655317104b77"
        },
        "uuid": "479879de-3342-430c-9a4a-6b181f4a2558",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "95ff7634-880c-4250-a1dd-fbec3f15d8e1"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-04-02T13:27:58+01:00",
        "expires_at": "2025-04-02T13:27:58+01:00",
        "updated_at": "2025-04-02T13:27:58+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}