Skip to content
campaiDeveloper
campai.com

Booking · Bookings

POST/{organizationId}/{mandateId}/booking/bookings/listReads only

List bookings

Returns a list of bookings for a given mandate

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
Also checked, depending on the request and the records it touches
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • sortobject of string
    asc desc
    Keys: one of 64 values or 1 pattern
    _id mandate type bookingNumber buyer.type buyer.name buyer.nameNormalized buyer.nameSort buyer.email buyer.phone buyer.address.country buyer.address.state buyer.address.zip buyer.address.city buyer.address.addressLine buyer.address.details1 buyer.address.details2 buyer.userId buyer.account buyer.contact.name buyer.contact.type buyer.contact.nameNormalized buyer.contact.nameSort buyer.contact.contact buyer.contact.image.resource buyer.contact.image.fileName buyer.contact.image.contentType buyer.contact.image.fileSizeBytes buyer.contact.user.name buyer.contact.user.type buyer.contact.user.userId buyer.contact.user.image.resource buyer.contact.user.image.fileName buyer.contact.user.image.contentType buyer.contact.user.image.fileSizeBytes buyer.payment.paymentMethod buyer.payment.sepaDirectDebit.iban buyer.payment.sepaDirectDebit.bic buyer.payment.online.paymentIntent buyer.payment.online.provider buyer.payment.online.paymentMode buyer.payment.online.onlineDebitCollection buyer.personName buyer.receiptMode receipts formResult.schema totalPrice totalPoints usedPunchCardNumbers discountCode status paymentStatus cancelations records createdAt event.event event.eventTitle event.eventDate event.seriesId event.qrPasses event.refundPolicies event.invitationCode resource.resources resource.resourceNames

    pattern ^formResult\.data\.[\s\S]{0,}$

  • limitinteger

    0–100 · default 50

  • offsetinteger

    at least 0 · default 0

  • returnCountboolean

    default false

  • typestring
    event resource
  • contactIdid
  • searchTermstring
  • userFilterstringnullable

    A stringified json object representing a property filter

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

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • countinteger

    at least 0

  • bookingsobject[]
    18 properties
    • _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[]
Response200
{
  "count": 0,
  "bookings": [
    {
      "_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
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.