List rooms and equipment

GET/api/v1/mailbox/calendar/rooms
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Rooms (ROOM) and things (RESOURCE, e.g. a projector) you can add to an event like an attendee. Empty for most organizations.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Request

GET/api/v1/mailbox/calendar/rooms
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/calendar/rooms' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataarray<object>
    • emailstring
    • namestring
    • typestringROOM | RESOURCE
    • capacityinteger or null
    • locationstring or null
200application/json
{
  "type": "success",
  "msg": "Rooms retrieved successfully",
  "data": [
    {
      "email": "boardroom@yourdomain.com",
      "name": "Board room",
      "type": "ROOM",
      "capacity": 12,
      "location": "3rd floor"
    }
  ]
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.

Every status, with what causes it and what to do, is on the error reference.