Get all risks

GET /api/v2/risks
Personal access token & OAuth2

This endpoint will return all risks in the firm relevant to the user accessing them.

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[level] integer

    Filter by the numeric level value. Whole number between 1 and 1,000.

  • filter[level_string] string

    Filter by the string/text version of risk level of the client.

  • filter[completed_after] string

    Date (with optional time) to filter when the record was created after. Example 2022-04-05

  • filter[completed_before] string

    Date (with optional time) to filter when the record was created before. Example 2022-05-31

  • filter[risk_assessment_provider] string

    Filter by the name of provider for the risk assessment.

  • filter[time_horizon_set_after] string

    Date (with optional time) to filter when the record was created after. Example 2022-04-05 07:45

  • filter[time_horizon_set_before] string

    Date (with optional time) to filter when the record was created before. Example 2022-05-31

  • filter[account_uuids] string

    Filter by a comma separated list of account UUIDs.

  • filter[circle_uuids] string

    Filter by a comma separated list of circle UUIDs.

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [account, completed_by].

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_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]

      Additional properties are allowed.
GET /api/v2/risks 
curl \
 --request GET https://api.plannrcrm.com/api/v2/risks \
 --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": "342604ec-2c11-4a38-a208-4e1d0f44fa9b",
      "level": 52,
      "account": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "8ba1041e-03fb-42b5-bdd8-dd0cdf327160",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-02-20T10:13:06+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-02-20T10:13:06+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-02-20T10:13:06+00:00",
      "updated_at": "2025-02-20T10:13:06+00:00",
      "completed_at": "2024-02-20T10:13:06+00:00",
      "completed_by": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "89aa0c81-9267-4a18-87f5-b9f3bb4146ff",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-02-20T10:13:06+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-02-20T10:13:06+00:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-02-20T10:13:06+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-02-20T10:13:06+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-02-20T10:13:06+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-02-20T10:13:06+00:00"
      },
      "level_string": "Moderately Aggressive",
      "time_horizon": "For the next 5 years",
      "time_horizon_set_at": "2025-01-20T10:13:06+00:00",
      "risk_assessment_provider": "Defaqto"
    }
  ]
}