Get an Activity

get/public/v1/activities/{activity}

get/public/v1/activities/{activity}

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

Response

{
  "data": {
    "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

activitystringrequired
The activity UUID

Response

200application/json

ActivityResource

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