List an Activity's Instances

get/public/v1/activities/{activity}/instances

Returns the activity's individual occurrences, oldest first. A support belongs to one instance rather than to the activity itself, so an instance id is what identifies the occurrence it was scheduled against.

get/public/v1/activities/{activity}/instances

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

activitystringrequired
The activity UUID

Query parameters

sortstring
Sort the results. Prefix with '-' for descending. One of: start_time. Defaults to start_time ascending.
Example:-start_time
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 ActivityInstanceResource

dataobject[]required
▶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 | null
  ▶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
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