Goals

List goals

List all estate management goals for a case.

get/cases/{case_id}/goals

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

status'pending' | 'in_progress' | 'completed'

Response

List of goals.

Example response

{
  "data": [
    {
      "id": "01K5XE10FJ8T55HRYE78AN7MNO",
      "type": "discover_financial_accounts",
      "status": "in_progress"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.