Get a Goal

get/public/v1/goals/{goal}

get/public/v1/goals/{goal}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/goals/{goal}' \
  --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"
  }
}

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

goalstringrequired
The goal UUID

Response

200application/json

ParticipantGoalResource

dataobjectrequired
▶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

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors