Skip to main content
GET
/
cases
/
{case_id}
/
goals
List goals
curl --request GET \
  --url https://api.example.com/v1/cases/{case_id}/goals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01K5XE10FJ8T55HRYE78AN7MNO",
      "type": "discover_financial_accounts",
      "status": "in_progress",
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

Query Parameters

​
page
integer
default:1

Page number for pagination.

Required range: x >= 1
​
per_page
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
pending,
in_progress,
completed

Response

List of goals.

​
data
object[]
​
meta
object