Offices report

POST/v1/OfficeReport/GetOfficeReservations

Scope: officereservation.read

Retrieve a paginated list of office reservations.

Use this report to export office reservation data. Results can be filtered by status, booking type, booker details, and date ranges.

Request body

Parameters

pageNumberintegerOptional

Page number for pagination. Defaults to 1.

pageSizeintegerOptional

Page size for pagination. Defaults to 100.

statusinteger[]Optional

Filter to one or more reservation status identifiers.

bookingTypesinteger[]Optional

Filter to one or more booking type identifiers.

officeReservationIdintegerOptional

Filter to a specific office reservation identifier.

bookerEmailstringOptional

Filter to reservations where the booker email contains this value.

bookerCompanystringOptional

Filter to reservations where the booker company contains this value.

bookerNamestringOptional

Filter to reservations where the booker name contains this value.

startDatedate-timeOptional

Filter reservations with a start date on or after this value.

endDatedate-timeOptional

Filter reservations with an end date on or before this value.

createdSincedate-timeOptional

Filter reservations created on or after this value.

createdUntildate-timeOptional

Filter reservations created on or before this value.

modifiedSincedate-timeOptional

Filter reservations modified on or after this value.

modifiedUntildate-timeOptional

Filter reservations modified on or before this value.

expand.reservationDaysbooleanOptional

Include reservation day details.

expand.userDetailsbooleanOptional

Include user details.

expand.customDatabooleanOptional

Include custom data values.

expand.attendeesbooleanOptional

Include attendee details.

expand.benchmarkDatabooleanOptional

Include benchmark data.

expand.extraItemsbooleanOptional

Include extra item details.

Response

Returns a paginated list of OfficeReport objects.

The OfficeReport object

officeReservationIdinteger

Unique office reservation identifier.

statusstring

Current reservation status name.

statusIdinteger

Current reservation status identifier.

startDatedate-time

Start date and time of the reservation.

endDatedate-time

End date and time of the reservation.

recordCreateddate-time

When the reservation was created.

recordModifieddate-time

When the reservation was last modified.

attendeesinteger

Number of attendees.

maxAttendeesinteger

Maximum capacity of the reserved space.

totalinteger

Total amount in cents.

netValueinteger

Net value in cents.

vatinteger

VAT amount in cents.

vatRatedecimal

VAT rate applied.

totalSavingsinteger

Total savings in cents.

commissioninteger

Commission amount in cents.

totalCommissioninteger

Total commission in cents.

exchangeRatedecimal

Exchange rate used.

bookingCurrencyISOCodestring

ISO 4217 currency code.

meetingNamestring

Name of the meeting.

bookingTypeIdinteger

Identifier of the booking type.

bookingTypeNamestring

Name of the booking type.

amountPaidinteger

Amount paid in cents.

amountRefundedinteger

Amount refunded in cents.

billingReferenceNumberstring

Billing reference number.

isCompanyPreferredboolean

Whether the office is preferred by the company.

isAffiliatePreferredboolean

Whether the office is preferred by the affiliate.

dateCancelleddate-time

Date the reservation was cancelled, if applicable.

acceptedDatedate-time

Date the reservation was accepted.

Expandable collections

venueobject

Venue details. Included when venue data is expanded.

bookerobject

Booker details. Requires expand.userDetails.

companyobject

Company details. Included when company data is expanded.

approverobject

Approver details. Included when approver data is expanded.

officeobject

Office details. Included when office data is expanded.

officeReservationDaysarray

Day-by-day breakdown of the reservation. Requires expand.reservationDays.

officeReservationDayEquipmentsarray

Equipment items for the day.

officeReservationDayFoodDrinksarray

Food and drink items for the day.

officeReservationExtraobject

Extra reservation metadata.

benchmarkDataobject

Benchmark data for the office. Requires expand.benchmarkData.

meetingAttendeesarray

Attendees for the reservation. Requires expand.attendees.

attachmentsarray

Attachments for the reservation.

Pagination

pageNumberinteger

Current page number.

pageSizeinteger

Number of items per page.

totalCountinteger

Total number of matching entries.

Errors

Status	Meaning
`400 Bad Request`	Validation failed. Check the response for property-level errors.
`401 Unauthorized`	The Bearer token is missing, expired, or lacks the required scope.
`403 Forbidden`	The client is not permitted to view office reservations.

Example request

curl -X POST https://dashboard.alpha.meetingsbooker.com/reportingapi/v1/OfficeReport/GetOfficeReservations \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": [1],
    "pageSize": 50
  }'

var response = await client.PostAsJsonAsync(
    "https://dashboard.alpha.meetingsbooker.com/reportingapi/v1/OfficeReport/GetOfficeReservations",
    new
    {
        status = new[] { 1 },
        pageSize = 50
    });

var report = await response.Content.ReadFromJsonAsync<PaginatedList<AutomatedReportDTO>>();

Example response

{
  "items": [
    {
      "officeReservationId": 444,
      "status": "Confirmed",
      "statusId": 1,
      "startDate": "2025-06-01T09:00:00Z",
      "endDate": "2025-06-01T17:00:00Z",
      "recordCreated": "2025-01-10T11:00:00Z",
      "recordModified": "2025-01-15T14:30:00Z",
      "attendees": 6,
      "maxAttendees": 8,
      "total": 35000,
      "netValue": 30000,
      "vat": 5000,
      "vatRate": 0.20,
      "totalSavings": 0,
      "commission": 0,
      "totalCommission": 0,
      "exchangeRate": 1.0,
      "bookingCurrencyISOCode": "EUR",
      "meetingName": "Sprint planning",
      "bookingTypeId": 2,
      "bookingTypeName": "Office",
      "amountPaid": 35000,
      "amountRefunded": 0,
      "billingReferenceNumber": "INV-2025-00444",
      "isCompanyPreferred": true,
      "isAffiliatePreferred": false,
      "dateCancelled": null,
      "acceptedDate": "2025-01-12T10:00:00Z",
      "venue": {
        "venueId": 42,
        "venueName": "Grand Hotel Dublin",
        "venueCountry": "Ireland",
        "venueCity": "Dublin",
        "venueAddress": "1 Merrion Square, Dublin 2",
        "latitude": 53.3389,
        "longitude": -6.2505,
        "folderText": "Dublin venues"
      },
      "booker": {
        "userId": 102,
        "name": "Bob Taylor",
        "companyName": "Example Ltd",
        "email": "bob@example.com",
        "phone": "+353 1 234 5678"
      },
      "company": {
        "companyId": 1001,
        "companyName": "Example Ltd",
        "costCentreName": "Engineering",
        "costCentreId": 11,
        "costCentreCode": "ENG-001",
        "departmentId": 6,
        "departmentName": "Product",
        "affiliateCorporateId": "CORP-001",
        "affiliateCompanyId": "AFF-001"
      },
      "approver": {
        "approverUserId": 202,
        "name": "Carol White",
        "email": "carol@example.com"
      },
      "office": {
        "officeId": 50,
        "name": "Dublin Hub",
        "address": "1 Merrion Square, Dublin 2",
        "latitude": 53.3389,
        "longitude": -6.2505,
        "externalOfficeId": "OFF-DUB-001",
        "officeUrl": "https://offices.example.com/dublin-hub",
        "officeDescription": "Central Dublin coworking space",
        "countryLocationId": 1,
        "cityLocationId": 20,
        "countryName": "Ireland",
        "cityName": "Dublin",
        "officeImages": [
          "https://cdn.hubli.com/offices/50/1.jpg"
        ],
        "officeExtra": {
          "officeId": 50,
          "officeDescription": "Central Dublin coworking space",
          "bookingEngineType": 1,
          "bookingEngineTypeName": "Standard"
        }
      },
      "officeReservationDays": [
        {
          "officeReservationDayId": 1101,
          "officeReservationDurationTypeId": 1,
          "officeReservationDurationType": "Full day",
          "officeReservationVersionId": 6001,
          "officeReservationDayDate": "2025-06-01T00:00:00Z",
          "officeReservationId": 444,
          "reservationDate": "2025-06-01T00:00:00Z",
          "startTime": "2025-06-01T09:00:00Z",
          "endTime": "2025-06-01T17:00:00Z",
          "officeReservationDayRooms": [
            {
              "officeReservationDayRoomId": 2101,
              "officeReservationDayId": 1101,
              "venueRoomId": 301,
              "venueRoomShapeId": 2,
              "venueRoomShape": "Boardroom",
              "officeReservationVersionId": 6001,
              "attendees": 6,
              "venueRoomPrice": 30000,
              "venueRoomPriceExVat": 25000,
              "venueRoomVAT": 5000,
              "vatRate": 0.20,
              "officeRoomId": 501,
              "roomPrice": 30000,
              "venueRoom": {
                "venueRoomId": 301,
                "venueId": 42,
                "venueRoomName": "Wicklow Suite",
                "venueRoomImageUrl": "https://cdn.hubli.com/rooms/301.jpg"
              },
              "officeRoom": {
                "officeRoomId": 501,
                "officeId": 50,
                "name": "Boardroom A",
                "email": "boardroom-a@example.com",
                "mainImageUrl": "https://cdn.hubli.com/officerooms/501.jpg",
                "maxCapacity": 8,
                "description": "Executive boardroom",
                "externalOfficeRoomId": "ROOM-501",
                "isActive": true,
                "officeRoomShapes": [
                  {
                    "officeRoomShapeId": 1,
                    "officeRoomId": 501,
                    "officeShapeId": 2,
                    "shapeName": "Boardroom",
                    "capacity": 8
                  }
                ]
              }
            }
          ],
          "extrasItems": [],
          "officeReservationDayEquipments": [],
          "officeReservationDayFoodDrinks": []
        }
      ],
      "officeReservationExtra": {
        "officeReservationId": 444,
        "purchaseOrderNumber": "PO-12345",
        "costCentreCode": "ENG-001",
        "amountPaid": 350.00,
        "amountRefunded": 0.00,
        "companyApproverUserId": 202,
        "approver": {
          "approverUserId": 202,
          "name": "Carol White",
          "email": "carol@example.com"
        }
      },
      "benchmarkData": {
        "officeBenchmarkId": 1,
        "officeBenchmarkName": "Dublin office benchmark",
        "benchmarkStatus": "Active",
        "statusId": 1,
        "recordCreated": "2025-01-01T00:00:00Z",
        "recordModified": "2025-01-01T00:00:00Z",
        "benchmarkItems": [
          {
            "officeBenchmarkItemId": 1,
            "officeBenchmarkId": 1,
            "itemName": "Room rate",
            "itemDescription": "Average room rate benchmark",
            "categoryName": "Cost",
            "score": 85.0,
            "comments": "Within budget"
          }
        ]
      },
      "meetingAttendees": [
        {
          "meetingAttendeeId": 1,
          "officeReservationId": 444,
          "attendeeName": "Bob Taylor",
          "attendeeEmail": "bob@example.com",
          "attendeePhone": "+353 1 234 5678",
          "isOrganiser": true,
          "attendanceStatus": "Attending",
          "attendanceStatusId": 1
        }
      ],
      "attachments": [
        {
          "officeReservationAttachmentsId": 1,
          "officeReservationId": 444,
          "fileName": "agenda.pdf",
          "originalFileName": "sprint-planning-agenda.pdf",
          "fileSize": 245760,
          "contentType": "application/pdf",
          "attachmentType": "Agenda",
          "attachmentTypeId": 1,
          "recordCreated": "2025-01-10T11:00:00Z",
          "recordModified": "2025-01-10T11:00:00Z"
        }
      ],
      "transactionRequest": [],
      "customFieldDatas": []
    }
  ],
  "pageNumber": 1,
  "pageSize": 50,
  "totalCount": 1
}