GET /api/v2/portal/actions
Personal access token & O auth2

Get all related actions for the referenced account uuid (see header)

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[completed] string

    affects whether to include actions which have been completed. Valid options are "exclude", "include", "only". (default: "exclude")

  • 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]
      Hide data attributes Show data attributes object
      • uuid string
      • title string
      • description string
      • type string
      • is_completed string
      • resource object
        Hide resource attributes Show resource attributes object
        • uuid string
        • created_at string
        • updated_at string
        • status string
        • completed_at string
        • invitation_text string
        • schema string
        • latest_file string
        • account string
        • invitation_url string
        • fact_find_passes string
      • created_at string
GET /api/v2/portal/actions 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/portal/actions' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "type": "fact_find_request",
      "uuid": "2f3f04de-0dbd-433b-8fcf-56116ea71650",
      "title": "Signature Request",
      "resource": {
        "uuid": "a4ff32b1-6784-436b-913e-462c50b26e0a",
        "schema": "App\\Http\\Resources\\FactFind\\FactFindSchemaResource",
        "status": "complete",
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "created_at": "2025-12-04T22:09:17+00:00",
        "updated_at": "2025-12-04T22:09:17+00:00",
        "latest_file": "App\\Http\\Resources\\FileResource",
        "completed_at": "2025-11-29T22:09:17+00:00",
        "invitation_url": "https://api.plannrcrm.com/fact-find/d1e2b901-eca5-4a1d-8365-525f2fdd94b6/eccd6484-a684-4cc4-ad99-b43bf1f92640",
        "invitation_text": "Please complete this fact-find!",
        "fact_find_passes": "App\\Http\\Resources\\FactFindPassResource"
      },
      "created_at": "2025-12-04T22:09:17+00:00",
      "description": "Invited to complete the action item",
      "is_completed": "true"
    }
  ]
}