List Goals for a Participant

get/public/v1/participants/{participant}/goals

get/public/v1/participants/{participant}/goals

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/participants/{participant}/goals' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "g1o2a3l4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "name": "Improve social interactions",
      "goal_type": "short_term",
      "description": "Participant wants to improve their social skills",
      "achievement_strategy": "Attend weekly social groups",
      "barriers": "Anxiety in group settings",
      "status": "active",
      "achieved_at": "2024-06-15T10:30:00+00:00",
      "archived_at": "2024-01-15T10:30:00+00:00",
      "created_at": "2024-01-15T10:30:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

participantstringrequired
The participant UUID

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of ParticipantGoalResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:g1o2a3l4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestringrequired
  Example:Improve social interactions
- goal_typestring | nullrequired
  Example:short_term
- descriptionstring | nullrequired
  Example:Participant wants to improve their social skills
- achievement_strategystring | nullrequired
  Example:Attend weekly social groups
- barriersstring | nullrequired
  Example:Anxiety in group settings
- statusstringrequired
  Example:active
- achieved_atstring | nullrequired
  Example:2024-06-15T10:30:00+00:00
- archived_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors