Get all claims of a plan

GET /api/v1/plans/{plan_uuid}/claim

Headers

Path parameters

plan_uuid string Required

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
per_page integer

Number of results to return with pagination (Default 15. Max 500).
sort string

Field to sort by. Valid fields are [created_at, updated_at, claim_start_date, claim_start_date, claim_amount]. Negative sign to denote DESC. Defaults to '-created_at'.

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Additional properties are allowed.

GET /api/v1/plans/{plan_uuid}/claim

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/claim \
 -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": "35d009a9-f3ff-4df0-84db-55c431593f1c",
      "client": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "bd096d6e-a2d6-43fc-91ac-ea8b380f370c",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-11-20T13:24:03+00:00",
        "first_name": "Gareth",
        "updated_at": "2024-11-20T13:24:03+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": "2024-11-20T13:24:03+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-11-20T13:24:03+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-11-20T13:24:03+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-11-20T13:24:03+00:00"
      },
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+00:00",
      "claim_notes": "Claim notes",
      "claim_amount": {
        "amount": {
          "example": "25000000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£250,000.00",
          "description": "Money amount formatted with currency"
        }
      },
      "claim_end_date": "2029-11-20",
      "claim_start_date": "2023-11-20"
    }
  ]
}