Link Search Menu Expand Document

Get Activities endpoint

Returns all activities that could be used on bookings.

Parameters:

  • pool string to identify the Wherewolf app requesting the list of activities.
  • skip integer to indicate how many records are to be skipped.

Headers:

  • API-key API key to authenticate the request.

Request example

curl -X GET \
  __BOOKING_SYSTEM_API__/activities?pool=wherewfolapp123&skip=0 \
  -H 'API-key: 123-123-123-123'

Where BOOKING_SYSTEM_API is a placeholder for the base url of your booking system’s API

The response is expected to return an object containing at least two properties:

  • activities an array of activity objects, where each object should at least contain the name of the activity and it’s internal id or code.
  • more a boolean flag to indicate if there are more activities available to be retrieved with pagination. When set to true, Wherewolf will execute a subsequent call with skip set to be the number of already retrieved activities skip += bookings.length.

Response example

{
    "activities": [
        { "activityId": "SWIM123", "name": "Swim" },
        { "activityId": "DIVE1", "name": "Dive" },
        { "activityId": "JMP", "name": "Jump" }
    ],
    "more": false
}