Skip to main content
GET
Get goals

Get All Goals

Retrieve a paginated list of goals with optional filtering by treatment plan, type, and status.

Headers

Query Parameters

  • page (optional): Page number (1-indexed). Default: 1. Minimum: 1
  • pageSize (optional): Number of items per page. Default: 25. Minimum: 1, Maximum: 100
  • treatmentPlanId (optional): Filter by treatment plan public ID
  • type (optional): Filter by goal type (frequency_duration, opportunity, rating, interval)
  • status (optional): Filter by goal status

Success Response (200)

Error Responses

400 - Validation Error

500 - Internal Server Error

Examples

cURL Example

JavaScript Example

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
pageSize
integer
default:25

Number of items per page

Required range: 1 <= x <= 100
treatmentPlanId
string

Filter by treatment plan public ID

type
enum<string>

Filter by goal type

Available options:
frequency_duration,
opportunity,
rating,
interval
status
string

Filter by goal status

Response

Successful response

data
object[]
required
pagination
object
required