Get an Activity Instance

get/public/v1/activity-instances/{activityInstance}

get/public/v1/activity-instances/{activityInstance}

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

Response

{
  "data": {
    "id": "i1n2s3t4-a5n6-47c8-9e0a-1b2c3d4e5f6a",
    "start_time": "2024-01-15T10:30:00+00:00",
    "end_time": "2024-01-15T12:30:00+00:00",
    "activity": {
      "id": "a1c2t3i4-v5i6-47t8-9y0a-1b2c3d4e5f6a",
      "name": "Tuesday Art Group",
      "timezone": "Australia/Sydney",
      "details": "Painting and drawing in the community room.",
      "capacity": 12,
      "cancelled": false
    }
  }
}

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

activityInstancestringrequired
The activity instance UUID

Response

200application/json

ActivityInstanceResource

dataobjectrequired
▶Show 4 child attributesHide child attributes
- idstringrequired
  Example:i1n2s3t4-a5n6-47c8-9e0a-1b2c3d4e5f6a
- start_timestringrequired
  Example:2024-01-15T10:30:00+00:00
- end_timestringrequired
  Example:2024-01-15T12:30:00+00:00
- activityobject | nullrequired
  ▶Show 6 child attributesHide child attributes
  idstringrequired
  Example:a1c2t3i4-v5i6-47t8-9y0a-1b2c3d4e5f6a
  namestringrequired
  Example:Tuesday Art Group
  timezonestringrequired
  Example:Australia/Sydney
  detailsstring | nullrequired
  Example:Painting and drawing in the community room.
  capacityinteger | nullrequired
  Example:12
  cancelledbooleanrequired
  True once the activity is cancelled. Cancelled activities are still returned, so filter on this before attaching a support to one of their instances.
  Example:false

Errors

401Unauthenticated
403Authorization error
404Not found