Skip to content
campaiDeveloper
campai.com

Booking · Bookings

GET/{organizationId}/{mandateId}/booking/bookings/{bookingId}Reads only

Get booking

Returns a specific booking for an organization and mandate, identified by the booking ID. The response includes cancellation receipt information. Actor details may be masked depending on the caller’s permissions.

Permissions

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

Who may call it

  • The caller must have organization access.
  • The caller needs mandate.read and booking.read.
  • Without user.read, non-contact actors other than the current actor are masked.
  • A contact actor’s linked user is also masked without user.read when the contact is not the current actor.
  • API actors are masked without apiKey.read, including the current actor. A non-current API actor also needs user.read to remain unmasked.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • bookingIdidrequired
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/bookings/YOUR_BOOKING_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • _idid
  • mandateid
  • typestring
    event resource
  • bookingNumberstring

    exactly 7 characters

  • buyerobject
    13 properties
    • typestring
      business person
    • namestring

      1–81 characters

    • nameNormalizedstring

      at least 1 characters

    • nameSortstring

      1–81 characters

    • emailstring
    • phonestring | string · phone
    • addressobjectnullable
      7 properties
      • countrystring
      • statestring
      • zipstring
      • citystring
      • addressLinestring
      • details1string
      • details2string
    • userIdstring

      at most 24 characters

    • accountinteger

      1–999999999

    • contactobjectnullable
      7 properties
      • namestring
      • typestring
      • nameNormalizedstring
      • nameSortstring
      • contactidnullable
      • imageobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • userobjectnullable
        4 properties
        • namestring
        • typestring
        • userIdstring
        • imageobjectnullable
          4 properties
          • resourcestring

            at least 1 characters

          • fileNamestring

            at most 128 characters

          • contentTypestring

            at most 75 characters

          • fileSizeBytesinteger

            at least 0

    • paymentobjectnullable
      3 properties
      • paymentMethodstring
        sepaCreditTransfer sepaDirectDebit cash online
      • sepaDirectDebitobjectnullable
        2 properties
        • ibanstring · iban
        • bicstringnullable
      • onlineobjectnullable
        4 properties
        • paymentIntentidnullable
        • providerstringnullable
          stripe paypal
        • paymentModestringnullable
          manual automatic
        • onlineDebitCollectionidnullable
    • personNamestring

      1–81 characters

    • receiptModestring
      gross net
  • receiptsobject[]
    8 properties
    • receiptid
    • receiptNumberstring

      at most 30 characters

    • paymentStatusstring
      unpaid partial paid
    • paymentTermsstring

      at most 2000 characters

    • paymentDueDatestring · date-timenullable
    • paymentTotalAmountLeftToPayintegernullable

      0–9999999999

    • canceledAtstring · date-timenullable
    • externalRefundobjectnullable
      2 properties
      • providerstring
        stripe paypal
      • amountinteger

        at most 9999999999

  • formResultobjectnullable
    2 properties
    • schemaobject[]
      5 properties
      • pageIdstring
      • idstring
      • labelstring
      • itemCaptionstring
      • fieldsobject[]
        9 properties
        • idstring
        • keystring

          1–24 characters · pattern ^[A-Za-z_$][A-Za-z0-9_$]*$

        • typestring
          20 values
          placeholder html spacer text select multiSelect date time dateTime number file signature rating matrix boolean address calculated info termsPrivacy paymentMethod
        • labelstring

          1–140 characters

        • bindPropertyPathstring
        • textobject
          1 property
          • formatstring
            text multiline regex email phone url iban bic
        • dateobject
          1 property
          • formatstring
        • calculatedobject
          2 properties
          • resultTypestring
            number string boolean dateOnly dateTime option
          • optionsobject[]

            at most 1000 items

            4 properties
            • idstring

              1–140 characters

            • valuestring

              1–140 characters

            • labelstring

              1–140 characters

            • hintstring

              at most 200 characters

        • matrixobject
          3 properties
          • rowsobject[]
            4 properties
            • idstring

              1–140 characters

            • valuestring

              1–140 characters

            • labelstring

              1–140 characters

            • hintstring

              at most 200 characters

          • columnsobject[]
            4 properties
            • idstring

              1–140 characters

            • valuestring

              1–140 characters

            • labelstring

              1–140 characters

            • hintstring

              at most 200 characters

          • multiSelectboolean
    • dataobject of one of 7 types | object of one of 7 types | object (recursive)[] | (one of 7 types)[][]

      The answers of a form, by the ID of each field. A repeating group holds a list of its entries under its own ID.

  • totalPriceinteger

    0–9999999999

  • totalPointsinteger

    at least 0

  • usedPunchCardNumbersstring[]
  • discountCodestringnullable
  • statusstring
    confirmed partialCancelation canceled
  • paymentStatusstringnullable
    unpaid partial paid
  • cancelationsobject[]
    8 properties
    • recordNumberstring

      exactly 10 characters

    • canceledAtstring · date-time
    • reasonstring

      at most 240 characters

    • priceRefundintegernullable

      0–9999999999

    • pointsRefundintegernullable

      at least 0

    • partialboolean
    • refundPayoutobject
    • refundReceiptBreakdownobject[]
      2 properties
      • receiptid
      • amountinteger

        at most 9999999999

  • recordsinteger
  • createdAtstring · date-timenullable
  • eventobject
    7 properties
    • eventid
    • eventTitlestring
    • eventDatestring · date-time
    • seriesIdstring
    • qrPassesobject[]nullable
      3 properties
      • kindstring
      • targetobject
      • qrPassTokenstring
    • refundPoliciesobject[]nullable

      at most 8 items

      3 properties
      • refundUntilobject
        2 properties
        • valuenumber

          at least 0

        • unitstring
          hours days weeks months years
      • priceModifierobject
        2 properties
        • valueinteger

          0–9999999999

        • typestring
          % amount
      • pointModifierobject
        2 properties
        • valueinteger

          0–9999999999

        • typestring
          % amount
    • invitationCodestringnullable

      at most 32 characters

  • resourceobject
    2 properties
    • resourcesid[]
    • resourceNamesstring[]
  • cancellationReceiptsobject[]
    5 properties
    • receiptid
    • totalRefundableinteger

      0–9999999999

    • isCanceledboolean
    • createsMonetaryRefundboolean
    • requiresRefundPayoutDetailsboolean
Response200
{
  "_id": "000000000000000000000001",
  "mandate": "000000000000000000000001",
  "type": "event",
  "bookingNumber": "string",
  "buyer": {
    "type": "business",
    "name": "string",
    "nameNormalized": "string",
    "nameSort": "string",
    "email": "",
    "phone": "",
    "address": {
      "country": "string",
      "state": "string",
      "zip": "string"
    },
    "userId": "string",
    "contact": {
      "name": "string",
      "type": "contact",
      "nameNormalized": "string",
      "nameSort": "string",
      "contact": "000000000000000000000001",
      "image": {
        "resource": "string"
      },
      "user": {
        "name": "string",
        "type": "user",
        "userId": "string",
        "image": {
          "resource": "string"
        }
      }
    },
    "payment": {
      "paymentMethod": "sepaCreditTransfer",
      "sepaDirectDebit": {
        "iban": "string",
        "bic": "string"
      },
      "online": {
        "paymentIntent": "000000000000000000000001",
        "provider": null
      }
    }
  },
  "receipts": [
    {
      "receipt": "000000000000000000000001",
      "receiptNumber": "string",
      "paymentStatus": "unpaid",
      "paymentTerms": "string",
      "paymentDueDate": null,
      "paymentTotalAmountLeftToPay": null,
      "canceledAt": null
    }
  ],
  "formResult": {
    "schema": [
      {
        "id": "string",
        "label": "string",
        "fields": [
          {
            "id": "string",
            "type": "placeholder"
          }
        ]
      }
    ],
    "data": {
      "key": "2026-10-22T12:00:00Z"
    }
  },
  "totalPrice": 0,
  "totalPoints": 0,
  "usedPunchCardNumbers": [
    "string"
  ],
  "discountCode": "string",
  "status": "confirmed",
  "paymentStatus": "unpaid",
  "cancelations": [
    {
      "recordNumber": "string",
      "canceledAt": "2026-06-15T22:30:00Z",
      "reason": "string",
      "priceRefund": 0,
      "pointsRefund": 0
    }
  ],
  "records": 1,
  "cancellationReceipts": [
    {
      "receipt": "000000000000000000000001",
      "totalRefundable": 0,
      "isCanceled": true,
      "createsMonetaryRefund": true,
      "requiresRefundPayoutDetails": true
    }
  ]
}

Errors

Other errors

StatusErrorWhen
404Booking was not foundIf the booking is not found, the endpoint returns HTTP 404 with key routes.booking.bookings.noBooking.

Errors nearly every request can meet are listed under Errors.