Get all fact-find requests the client owns.

GET /api/v1/client/{client_id}/fact-find/requests

Path parameters

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/client/{client_id}/fact-find/requests 
curl \
 -X GET https://api.plannrcrm.com/api/v1/client/client_id/fact-find/requests \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "1a26d8cd-b491-4ffb-83cf-6a3536512051",
      "schema": {
        "name": "Default fact-find",
        "uuid": "96ae6c82-0ad9-45f9-a870-9b66bb2fa41f",
        "created_at": "2024-10-16T11:10:13+01:00",
        "updated_at": "2024-10-16T11:10:13+01:00",
        "archived_at": "2024-10-15T11:10:13+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",
      "created_at": "2024-10-16T11:10:13+01:00",
      "updated_at": "2024-10-16T11:10:13+01:00",
      "latest_file": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Welcome to Plannr",
        "size": "21691783",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "type",
        "uuid": "5169e9ec-6082-4ad8-bf84-2fe12e4cdc95",
        "parent": "Object",
        "status": "uploaded",
        "account": "App\\Http\\Resources\\AccountResource",
        "filename": "Welcome to Plannr.pdf",
        "progress": "100",
        "extension": "pdf",
        "created_at": "2024-10-16T11:10:13+01:00",
        "updated_at": "2024-10-16T11:10:13+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2024-10-16T11:10:13+01:00",
        "download_url": "https://plannr.valet/file/0588b5a1-45c8-49e5-b453-3d54a6964e9c/download",
        "last_modified": "2024-10-16T11:10:13+01:00",
        "original_created_at": "2024-10-16T11:10:13+01:00"
      },
      "completed_at": "2024-10-11T11:10:13+01:00",
      "invitation_text": "Please complete this fact-find!"
    }
  ]
}