Skip to content
campaiDeveloper
campai.com

Booking ยท Bookings

GET/{organizationId}/{mandateId}/booking/booking-countersReads only

Get booking counters

Returns, for each booking type with at least one booking, how many bookings were made from the first of this month until today and in the same days of the previous month, and their amount in cents this month. Canceled bookings are left out of the figures

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • booking.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/booking-counters' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • typesobject[]
    4 properties
    • typestring
      event resource
    • bookedThisMonthinteger

      at least 0

    • previousMonthBookedinteger

      at least 0

    • amountThisMonthnumber

      at least 0

Response200
{
  "types": [
    {
      "type": "event",
      "bookedThisMonth": 0,
      "previousMonthBooked": 0,
      "amountThisMonth": 0
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.