Get all Actions belonging to an account

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": "c77d1940-2e07-4345-b988-0caba9d56736",
      "title": "Signature Request",
      "resource": {
        "uuid": "ef55f11e-a89c-4d36-8f39-c9ef8e521b9c",
        "schema": "App\\Http\\Resources\\FactFind\\FactFindSchemaResource",
        "status": "complete",
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "created_at": "2025-08-07T13:41:48+01:00",
        "updated_at": "2025-08-07T13:41:48+01:00",
        "latest_file": "App\\Http\\Resources\\FileResource",
        "completed_at": "2025-08-02T13:41:48+01:00",
        "invitation_url": "https://api.plannrcrm.com/fact-find/80182e6c-93a3-409c-9c14-81bdf12794e2/041cb866-8fce-46ce-b537-b7d6a723ce01",
        "invitation_text": "Please complete this fact-find!",
        "fact_find_passes": "App\\Http\\Resources\\FactFindPassResource"
      },
      "created_at": "2025-08-07T13:41:48+01:00",
      "description": "Invited to complete the action item",
      "is_completed": "true"
    }
  ]
}