Kadence logo
API docs by Redocly

Kadence Public API (1.1.0)

Kadence is the all-in-one software platform that helps your team thrive at hybrid work. With our public API you'll have the capability to seamlessly integrate your own applications with the Kadence, boosting employee productivity, enabling in-person collaboration, and maximizing your workspace to do more with less. To get started, check out our developer getting started guide. You can also check out our sample applications on GitHub.

Bookable Day

Get a collection of Bookable Days

Get a list of all days that a booking can be made for specific user in a specific building.

Authorizations:
oauth
query Parameters
buildingId
required
string
Example: buildingId=01CBCV1CT3BM8A52SEJ2J5F4EB

The building identifier to get a collection of bookable days for.

userId
required
string
Example: userId=01CADV1CT3BM8A52SEJ2J5F4EB

The user identifier to get a collection of bookable days for.

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
start
string <date-time>

The start of the bookable day (in UTC). If the bookable day is "today", and the building is currently open, this will be the earliest time at which the api will accept a booking.

end
string <date-time>

The end of the bookable day (in UTC).

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "start": "2023-07-01T09:00:00+00:00",
      • "end": "2023-07-01T17:00:00+00:00"
      }
    ],
  • "hydra:totalItems": 0
}

Retrieves a Bookable Day resource.

Retrieves a Bookable Day resource.

Authorizations:
oauth
path Parameters
id
required
string

PublicBookableDay identifier

Responses

Bookable Onsite Pass

Get a description of onsite availability for a building in a time period

Authorizations:
oauth
query Parameters
buildingId
required
string
Example: buildingId=01CBCV1CT3BM8A52SEJ2J5F4EB

The building identifier to get onsite pass information for

startDateTime
required
string
Example: startDateTime=2023-07-03T09:00:00

Proposed UTC booking start date time in format YYYY-MM-DDThh:mm:ss

endDateTime
required
string
Example: endDateTime=2023-07-03T09:00:00

Proposed UTC booking end date time in format YYYY-MM-DDThh:mm:ss

Responses

Response Schema: application/ld+json
string or object
One of
string
@id
string
@type
string
numPassesAvailable
integer or null

The number of passes available. If the building does not limit onsite availability, this will be null, unless there is no availability for some other reason, in which case it will be 0.

available
boolean

Are there any available passes?

startDateTime
string <date-time>

The date and time for the start of the pass.

endDateTime
string <date-time>

The date and time for the end of the pass.

unavailabilityReason
string or null
Enum: "buildingClosure" "openingHours" "buildingClosed" "noCapacity" "unknown" null

Why are no passes available. This will be null if there is availability

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "numPassesAvailable": 25,
  • "available": true,
  • "startDateTime": "2017-07-21T09:30:00+00:00",
  • "endDateTime": "2017-07-21T17:00:00+00:00",
  • "unavailabilityReason": "buildingClosure"
}

Bookable Space

Get Bookable Spaces

Get a list of all the spaces on a specific floor, which may be booked for a specific user during a specific time period.

Authorizations:
oauth
query Parameters
floorId
required
string
Example: floorId=01GTBV1CT3BM8A42SEJ2J5F4EG

Floor identifier

userId
required
string
Example: userId=01GTBV1CT3BM8A42SEJ2J5F4EG

User identifier

startDateTime
required
string
Example: startDateTime=2023-07-03T09:00:00

UTC Booking start date time in format YYYY-MM-DDThh:mm:ss

endDateTime
required
string
Example: endDateTime=2023-07-03T17:00:00

UTC Booking start date time in format YYYY-MM-DDThh:mm:ss

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Desk 01",
      • "type": "desk",
      • "neighborhood": {
        • "@context": "string",
        • "@id": "string",
        • "@type": "string",
        • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
        • "name": "Sales"
        }
      }
    ],
  • "hydra:totalItems": 0
}

Booking

Get a collection of bookings

Get a collection of bookings for your tenant

Authorizations:
oauth
query Parameters
id
string
Example: id=01GTBV1CT3BM8A42SEJ2J5F4EG

Booking identifier

startDate
string
Deprecated
Example: startDate=2023-01-01

Booking start date in format YYYY-MM-DD (deprecated for startDateTime)

endDate
string
Deprecated
Example: endDate=2023-01-02

Booking end date in format YYYY-MM-DD (deprecated for endDateTime)

startDateTime[local_before]
string
Example: startDateTime[local_before]=2023-01-01T14:00:00

Filter by Booking start date-time on or before this date-time (adjusted to building timezone)

endDateTime[local_before]
string
Example: endDateTime[local_before]=2023-01-01T14:00:00

Filter by Booking end date-time on or before this date-time (adjusted to building timezone)

endDateTime[local_strictly_before]
string
Example: endDateTime[local_strictly_before]=2023-01-01T14:00:00

Filter by Booking end date-time before this date-time (adjusted to building timezone)

endDateTime[local_after]
string
Example: endDateTime[local_after]=2023-01-01T14:00:00

Filter by Booking end date-time on or after this date-time (adjusted to building timezone)

endDateTime[local_strictly_after]
string
Example: endDateTime[local_strictly_after]=2023-01-01T14:00:00

Filter by Booking end date-time after this date-time (adjusted to building timezone)

endDateTime[before]
string
Example: endDateTime[before]=2023-01-01T14:00:00

Filter by Booking end date-time on or before this date-time

endDateTime[strictly_before]
string
Example: endDateTime[strictly_before]=2023-01-01T14:00:00

Filter by Booking end date-time before this date-time

endDateTime[after]
string
Example: endDateTime[after]=2023-01-01T14:00:00

Filter by Booking end date-time on or after this date-time

endDateTime[strictly_after]
string
Example: endDateTime[strictly_after]=2023-01-01T14:00:00

Filter by Booking end date-time after this date-time

startDateTime[local_strictly_before]
string
Example: startDateTime[local_strictly_before]=2023-01-01T14:00:00

Filter by Booking start date-time before this date-time (adjusted to building timezone)

startDateTime[local_after]
string
Example: startDateTime[local_after]=2023-01-01T14:00:00

Filter by Booking start date-time on or after this date-time (adjusted to building timezone)

startDateTime[local_strictly_after]
string
Example: startDateTime[local_strictly_after]=2023-01-01T14:00:00

Filter by Booking start date-time after this date-time (adjusted to building timezone)

startDateTime[before]
string
Example: startDateTime[before]=2023-01-01T14:00:00

Filter by Booking start date-time on or before this date-time

startDateTime[strictly_before]
string
Example: startDateTime[strictly_before]=2023-01-01T14:00:00

Filter by Booking start date-time before this date-time

startDateTime[after]
string
Example: startDateTime[after]=2023-01-01T14:00:00

Filter by Booking start date-time on or after this date-time

startDateTime[strictly_after]
string
Example: startDateTime[strictly_after]=2023-01-01T14:00:00

Filter by Booking start date-time after this date-time

type
string
Enum: "desk" "room" "onsite"
Example: type=desk

Booking type

buildingId
string
Example: buildingId=02GTBV1CT3BM8A42SEJ2J5F4EB

Building identifier

floorId
string
Example: floorId=01BTBV1CT3BM8A42SEJ2J5F4EB

Floor identifier

neighbourhoodId
string
Example: neighbourhoodId=01BTBV1CT3BM8A42SEJ2J5F4EB

Neighbourhood identifier

spaceId
string
Example: spaceId=01CBCV1CT3BM8A52SEJ2J5F4EB

Space identifier

order[startDate]
string
Enum: "asc" "desc"
Example: order[startDate]=asc

Order by start date

order[endDate]
string
Enum: "asc" "desc"
Example: order[endDate]=asc

Order by end date

page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 500 ]
Default: 50

The number of items per page

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
object,null
photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "Booking",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "space": {
        • "@context": "string",
        • "@id": "string",
        • "@type": "string",
        • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
        • "name": "Desk 01",
        • "type": "desk",
        • "floor": {
          },
        • "neighborhood": {
          },
        • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
        },
      • "startDate": "2017-07-21T17:32:28+00:00",
      • "endDate": "2017-07-21T17:32:28+00:00",
      • "createdAt": "2017-07-21T17:32:28+00:00",
      • "updatedAt": "2017-07-21T17:32:28+00:00",
      • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "checkedInDate": "2017-07-21T17:32:28+00:00",
      • "checkedInSource": "web",
      • "checkInMethod": "doorAccess",
      • "checkOutMethod": "doorAccess",
      • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "checkedOutDate": "2017-07-21T17:32:28+00:00",
      • "checkOutSource": "web",
      • "permanent": false,
      • "hasGuests": false,
      • "guestBooking": false,
      • "recurringBooking": false,
      • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
      • "selfCertifySource": "web",
      • "source": "web",
      • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
      • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "cancelledDate": "2017-07-21T17:32:28+00:00",
      • "cancellationReason": "byUser",
      • "title": null,
      • "status": "booked",
      • "type": "desk",
      • "onlineMeeting": null,
      • "onlineMeetingUrl": null,
      • "icalUid": null,
      • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
      }
    ],
  • "hydra:totalItems": 0
}

Create a booking

Create a desk or onsite booking

Authorizations:
oauth
Request Body schema: application/json
userId
required
string

The user identifier of the user the booking is for

startDateTime
required
string

UTC Booking start date time in format YYYY-MM-DDThh:mm:ss

endDateTime
required
string

UTC Booking end date time in format YYYY-MM-DDThh:mm:ss

buildingId
string

Required for onsite bookings only - the id of the Building the booking is for.

spaceId
string

Required for desk bookings only - the id of the Space the booking is for.

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

Request samples

Content type
application/json
{
  • "userId": "01H59ZGH7HDQ4KAAN6RR1X8V7V",
  • "startDateTime": "2023-07-03T09:00:00",
  • "endDateTime": "2023-07-03T17:00:00",
  • "buildingId": "01H59ZGH7HDQ4KAAN6RR1X8V7V",
  • "spaceId": "01H59ZGH7HDQ4KAAN6RR1X8V7V"
}

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Booking",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "space": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Desk 01",
    • "type": "desk",
    • "floor": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Floor 01"
      },
    • "neighborhood": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Sales"
      },
    • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
    },
  • "startDate": "2017-07-21T17:32:28+00:00",
  • "endDate": "2017-07-21T17:32:28+00:00",
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "updatedAt": "2017-07-21T17:32:28+00:00",
  • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedInDate": "2017-07-21T17:32:28+00:00",
  • "checkedInSource": "web",
  • "checkInMethod": "doorAccess",
  • "checkOutMethod": "doorAccess",
  • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedOutDate": "2017-07-21T17:32:28+00:00",
  • "checkOutSource": "web",
  • "permanent": false,
  • "hasGuests": false,
  • "guestBooking": false,
  • "recurringBooking": false,
  • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
  • "selfCertifySource": "web",
  • "source": "web",
  • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
  • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "cancelledDate": "2017-07-21T17:32:28+00:00",
  • "cancellationReason": "byUser",
  • "title": null,
  • "status": "booked",
  • "type": "desk",
  • "onlineMeeting": null,
  • "onlineMeetingUrl": null,
  • "icalUid": null,
  • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
}

Get a single booking by identifier

Get a single booking if you know it's identifier.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Booking identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Booking",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "space": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Desk 01",
    • "type": "desk",
    • "floor": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Floor 01"
      },
    • "neighborhood": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Sales"
      },
    • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
    },
  • "startDate": "2017-07-21T17:32:28+00:00",
  • "endDate": "2017-07-21T17:32:28+00:00",
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "updatedAt": "2017-07-21T17:32:28+00:00",
  • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedInDate": "2017-07-21T17:32:28+00:00",
  • "checkedInSource": "web",
  • "checkInMethod": "doorAccess",
  • "checkOutMethod": "doorAccess",
  • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedOutDate": "2017-07-21T17:32:28+00:00",
  • "checkOutSource": "web",
  • "permanent": false,
  • "hasGuests": false,
  • "guestBooking": false,
  • "recurringBooking": false,
  • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
  • "selfCertifySource": "web",
  • "source": "web",
  • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
  • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "cancelledDate": "2017-07-21T17:32:28+00:00",
  • "cancellationReason": "byUser",
  • "title": null,
  • "status": "booked",
  • "type": "desk",
  • "onlineMeeting": null,
  • "onlineMeetingUrl": null,
  • "icalUid": null,
  • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
}

Cancel a booking

Cancel a booking. Cancellation will not be possible if the booking has already been cancelled or completed. By adding a userId to the body of the request the public api can attempt this operation on behalf of a specific user.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Booking identifier

header Parameters
Accept
required
string
Example: application/ld+json
Request Body schema: application/json
userId
string

The user identifier of the user the request is on behalf of. If set the API will check to ensure this user has the permission to cancel this booking.

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

Request samples

Content type
application/json
{
  • "userId": "01GTBV1CT3BM8A42SEJ2J5F4EG"
}

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Booking",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "space": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Desk 01",
    • "type": "desk",
    • "floor": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Floor 01"
      },
    • "neighborhood": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Sales"
      },
    • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
    },
  • "startDate": "2017-07-21T17:32:28+00:00",
  • "endDate": "2017-07-21T17:32:28+00:00",
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "updatedAt": "2017-07-21T17:32:28+00:00",
  • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedInDate": "2017-07-21T17:32:28+00:00",
  • "checkedInSource": "web",
  • "checkInMethod": "doorAccess",
  • "checkOutMethod": "doorAccess",
  • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedOutDate": "2017-07-21T17:32:28+00:00",
  • "checkOutSource": "web",
  • "permanent": false,
  • "hasGuests": false,
  • "guestBooking": false,
  • "recurringBooking": false,
  • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
  • "selfCertifySource": "web",
  • "source": "web",
  • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
  • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "cancelledDate": "2017-07-21T17:32:28+00:00",
  • "cancellationReason": "byUser",
  • "title": null,
  • "status": "booked",
  • "type": "desk",
  • "onlineMeeting": null,
  • "onlineMeetingUrl": null,
  • "icalUid": null,
  • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
}

Check in to a booking

Check in to a booking on behalf of a user using a specified method. Check in will not be possible if self-certification is required by the building and the user's whose booking it is has not self-certified for the day of the booking.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Booking identifier

header Parameters
Accept
required
string
Example: application/ld+json
Request Body schema: application/json
userId
required
string

The user identifier to check in on behalf of. This would be the user performing an action like the user using the door access system.

method
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

The method used to check in.

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

Request samples

Content type
application/json
{
  • "userId": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "method": "doorAccess"
}

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Booking",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "space": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Desk 01",
    • "type": "desk",
    • "floor": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Floor 01"
      },
    • "neighborhood": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Sales"
      },
    • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
    },
  • "startDate": "2017-07-21T17:32:28+00:00",
  • "endDate": "2017-07-21T17:32:28+00:00",
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "updatedAt": "2017-07-21T17:32:28+00:00",
  • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedInDate": "2017-07-21T17:32:28+00:00",
  • "checkedInSource": "web",
  • "checkInMethod": "doorAccess",
  • "checkOutMethod": "doorAccess",
  • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedOutDate": "2017-07-21T17:32:28+00:00",
  • "checkOutSource": "web",
  • "permanent": false,
  • "hasGuests": false,
  • "guestBooking": false,
  • "recurringBooking": false,
  • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
  • "selfCertifySource": "web",
  • "source": "web",
  • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
  • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "cancelledDate": "2017-07-21T17:32:28+00:00",
  • "cancellationReason": "byUser",
  • "title": null,
  • "status": "booked",
  • "type": "desk",
  • "onlineMeeting": null,
  • "onlineMeetingUrl": null,
  • "icalUid": null,
  • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
}

Check out of a booking

Check out of a booking on behalf of a user using a specified method. Check out will not be possible if self-certification is required by the building and the user's whose booking it is has not self-certified for the day of the booking.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Booking identifier

header Parameters
Accept
required
string
Example: application/ld+json
Request Body schema: application/json
userId
required
string

The user identifier to check out on behalf of. This would be the user performing an action like the user using the door access system.

method
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

The method used to check out.

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

Request samples

Content type
application/json
{
  • "userId": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "method": "doorAccess"
}

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Booking",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "space": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Desk 01",
    • "type": "desk",
    • "floor": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Floor 01"
      },
    • "neighborhood": {
      • "@context": "string",
      • "@id": "string",
      • "@type": "string",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Sales"
      },
    • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
    },
  • "startDate": "2017-07-21T17:32:28+00:00",
  • "endDate": "2017-07-21T17:32:28+00:00",
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "updatedAt": "2017-07-21T17:32:28+00:00",
  • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedInDate": "2017-07-21T17:32:28+00:00",
  • "checkedInSource": "web",
  • "checkInMethod": "doorAccess",
  • "checkOutMethod": "doorAccess",
  • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "checkedOutDate": "2017-07-21T17:32:28+00:00",
  • "checkOutSource": "web",
  • "permanent": false,
  • "hasGuests": false,
  • "guestBooking": false,
  • "recurringBooking": false,
  • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
  • "selfCertifySource": "web",
  • "source": "web",
  • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
  • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "cancelledDate": "2017-07-21T17:32:28+00:00",
  • "cancellationReason": "byUser",
  • "title": null,
  • "status": "booked",
  • "type": "desk",
  • "onlineMeeting": null,
  • "onlineMeetingUrl": null,
  • "icalUid": null,
  • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
}

Get a user's bookings

Get a list of all the bookings made by a user.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

User identifier

query Parameters
type
string
Enum: "desk" "room" "onsite"
Example: type=desk

Booking type.

status
string
Enum: "booked" "checkedIn" "checkedOut" "completed" "cancelled" "noCheckIn"
Example: status=booked

Booking status.

startDateTime[local_before]
string
Example: startDateTime[local_before]=2023-01-01T14:00:00

Filter by Booking start date-time on or before this date-time (adjusted to building timezone)

endDateTime[local_before]
string
Example: endDateTime[local_before]=2023-01-01T14:00:00

Filter by Booking end date-time on or before this date-time (adjusted to building timezone)

endDateTime[local_strictly_before]
string
Example: endDateTime[local_strictly_before]=2023-01-01T14:00:00

Filter by Booking end date-time before this date-time (adjusted to building timezone)

endDateTime[local_after]
string
Example: endDateTime[local_after]=2023-01-01T14:00:00

Filter by Booking end date-time on or after this date-time (adjusted to building timezone)

endDateTime[local_strictly_after]
string
Example: endDateTime[local_strictly_after]=2023-01-01T14:00:00

Filter by Booking end date-time after this date-time (adjusted to building timezone)

endDateTime[before]
string
Example: endDateTime[before]=2023-01-01T14:00:00

Filter by Booking end date-time on or before this date-time

endDateTime[strictly_before]
string
Example: endDateTime[strictly_before]=2023-01-01T14:00:00

Filter by Booking end date-time before this date-time

endDateTime[after]
string
Example: endDateTime[after]=2023-01-01T14:00:00

Filter by Booking end date-time on or after this date-time

endDateTime[strictly_after]
string
Example: endDateTime[strictly_after]=2023-01-01T14:00:00

Filter by Booking end date-time after this date-time

startDateTime[local_strictly_before]
string
Example: startDateTime[local_strictly_before]=2023-01-01T14:00:00

Filter by Booking start date-time before this date-time (adjusted to building timezone)

startDateTime[local_after]
string
Example: startDateTime[local_after]=2023-01-01T14:00:00

Filter by Booking start date-time on or after this date-time (adjusted to building timezone)

startDateTime[local_strictly_after]
string
Example: startDateTime[local_strictly_after]=2023-01-01T14:00:00

Filter by Booking start date-time after this date-time (adjusted to building timezone)

startDateTime[before]
string
Example: startDateTime[before]=2023-01-01T14:00:00

Filter by Booking start date-time on or before this date-time

startDateTime[strictly_before]
string
Example: startDateTime[strictly_before]=2023-01-01T14:00:00

Filter by Booking start date-time before this date-time

startDateTime[after]
string
Example: startDateTime[after]=2023-01-01T14:00:00

Filter by Booking start date-time on or after this date-time

startDateTime[strictly_after]
string
Example: startDateTime[strictly_after]=2023-01-01T14:00:00

Filter by Booking start date-time after this date-time

startDate
string
Deprecated
Example: startDate=2023-01-02

Booking start date in format YYYY-MM-DD (deprecated for startDateTime)

endDate
string
Deprecated
Example: endDate=2023-01-02

Booking end date in format YYYY-MM-DD (deprecated for endDateTime)

page
integer >= 1
Example: page=1

The page of bookings to get

itemsPerPage
integer [ 1 .. 500 ]
Example: itemsPerPage=30

Number of bookings to get per page

id
string
Example: id=01GTBV1CT3BM8A42SEJ2J5F4EG

Booking identifier

floor.id
string
Example: floor.id=01GABC1CT3BM8A42SEJ2J5F4EG

Booking Floor identifier

neighborhood.id
string
Example: neighborhood.id=01GADV1CT3BM8A42SEJ2J5F4EG

Booking Neighborhood identifier

space.id
string
Example: space.id=01GADV1CT3BM8A42SEJ2J5F4EG

Booking Space identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the booking.

https://schema.org/identifier
createdUserId
string or null <iri-reference>

The IRI of the user who created the booking.

userId
string or null <iri-reference>

The IRI of the user who the booking is for.

object,null
Any of
string or object
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
object,null
photo
string or null <uuid>

The UUID of the photo of the space.

startDate
string or null <date-time>

The date and time of the beginning of the booking.

endDate
string or null <date-time>

The date and time of the end of the booking.

createdAt
string <date-time>

The date and time the booking was created at.

updatedAt
string <date-time>

The date and time the booking was last updated at.

checkedInUserId
string or null <iri-reference>

The IRI of the user who checked into the booking.

checkedInDate
string or null <date-time>

The date and time the booking was checked in at.

checkedInSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked in from.

checkInMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked in from the public API, the method used during check in.

checkOutMethod
string or null
Enum: "doorAccess" "wifi" "geofence" "sensor"

If checked out from the public API, the method used during check out.

checkedOutUser
string or null <iri-reference>

The IRI of the user who checked out of the booking.

checkedOutDate
string or null <date-time>

The date and time the booking was checked out at.

checkOutSource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was checked out from.

permanent
boolean

If this is a booking created from an assigned space.

hasGuests
boolean

If this booking has guests.

guestBooking
boolean

If this booking is for a guest.

recurringBooking
boolean

If this booking is part of a recurring series of bookings.

selfCertifiedDate
string or null <date-time>

The date and time the booking was self-certified at.

selfCertifySource
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was self-certified from.

source
string
Enum: "web" "ios" "android" "calendar" "publicApi" "slack" "msTeams" "unknown"

The platform the booking was created from.

autoReleasedDate
string or null <date-time>

The date and time the booking was auto released.

cancelledUserId
string or null <iri-reference>

The IRI of the user who cancelled the booking.

cancelledDate
string or null <date-time>

If cancelled, the date and time the booking was cancelled.

cancellationReason
string or null
Enum: "byUser" "byUserInBulk" "autoSpaceRelease" "permanentDesk" "changeInBuildingPolicy" "changeInCompanyPolicy" "removedFromCalendarByProvider" "removedFromCalendarByKadence" "calendarSyncError" "spaceNoLongerAvailable" "spaceRestricted" "spaceNotRestrictedAnymore" "userDeleted" "buildingClosure"

If cancelled, the reason for the cancellation.

title
string or null

If a room booking, the title of the associated calendar event.

status
string
Enum: "booked" "checkedIn" "checkedOut" "cancelled" "completed" "noCheckIn" "unknown"

The current booking status.

type
string
Enum: "desk" "room" "onsite"

The type of booking.

onlineMeeting
boolean or null

If a room booking, is the associated calendar event an online meeting?

onlineMeetingUrl
boolean or null

If a room booking, the online meeting joining url, if available.

icalUid
boolean or null

If a room booking, the associated iCal UID of the calendar event.

building
string <iri-reference>

The IRI of the building.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/bookings/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "Booking",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "createdUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "userId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "space": {
        • "@context": "string",
        • "@id": "string",
        • "@type": "string",
        • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
        • "name": "Desk 01",
        • "type": "desk",
        • "floor": {
          },
        • "neighborhood": {
          },
        • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
        },
      • "startDate": "2017-07-21T17:32:28+00:00",
      • "endDate": "2017-07-21T17:32:28+00:00",
      • "createdAt": "2017-07-21T17:32:28+00:00",
      • "updatedAt": "2017-07-21T17:32:28+00:00",
      • "checkedInUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "checkedInDate": "2017-07-21T17:32:28+00:00",
      • "checkedInSource": "web",
      • "checkInMethod": "doorAccess",
      • "checkOutMethod": "doorAccess",
      • "checkedOutUser": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "checkedOutDate": "2017-07-21T17:32:28+00:00",
      • "checkOutSource": "web",
      • "permanent": false,
      • "hasGuests": false,
      • "guestBooking": false,
      • "recurringBooking": false,
      • "selfCertifiedDate": "2017-07-21T17:32:28+00:00",
      • "selfCertifySource": "web",
      • "source": "web",
      • "autoReleasedDate": "2017-07-21T17:32:28+00:00",
      • "cancelledUserId": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "cancelledDate": "2017-07-21T17:32:28+00:00",
      • "cancellationReason": "byUser",
      • "title": null,
      • "status": "booked",
      • "type": "desk",
      • "onlineMeeting": null,
      • "onlineMeetingUrl": null,
      • "icalUid": null,
      • "building": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG"
      }
    ],
  • "hydra:totalItems": 0
}

Building

Get buildings

Get a list of all the buildings within your company.

Authorizations:
oauth
query Parameters
countryCode
string
Example: countryCode=GB

Filter buildings by the ISO 3166-1 alpha-2 code of the country where the building is located

city
string
Example: city=London

Filter buildings by the city where the building is located

name
string
Example: name=Bell Yard

Filter buildings by name

page
integer >= 1
Example: page=1

The page of buildings to get

itemsPerPage
integer [ 1 .. 500 ]
Example: itemsPerPage=30

Number of buildings to get per page

id
string
Example: id=01GTBV1CT3BM8A42SEJ2J5F4EG

Building identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the building.

https://schema.org/identifier
name
string

The name of the building.

timeZone
string

The IANA time zone that the building is in.

latitude
number <float>

The latitude of the building's location.

longitude
number <float>

The longitude of the building's location.

addressLine1
string

The first line of the building address.

addressLine2
string or null

The second line of the building address.

city
string

The name of the city that the building is in.

county
string or null

The name of the county that the building is in.

countryCode
string

The ISO 3166-1 alpha-2 country code that the building is in.

photo
string or null <uuid>

The UUID of the photo of the building.

createdAt
string <date-time>

The date and time that the building was created at.

modifiedAt
string <date-time>

The date and time that the building was last modified at.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "Building",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "London Office",
      • "timeZone": "Europe/London",
      • "latitude": 51.509865,
      • "longitude": -0.118092,
      • "addressLine1": "20 Fenchurch Street",
      • "addressLine2": null,
      • "city": "London",
      • "county": null,
      • "countryCode": "GB",
      • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3",
      • "createdAt": "2017-07-21T17:32:28+00:00",
      • "modifiedAt": "2017-07-21T17:32:28+00:00"
      }
    ],
  • "hydra:totalItems": 0
}

Get a single building by identifier

Get a single building if you know it's identifier.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Building identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the building.

https://schema.org/identifier
name
string

The name of the building.

timeZone
string

The IANA time zone that the building is in.

latitude
number <float>

The latitude of the building's location.

longitude
number <float>

The longitude of the building's location.

addressLine1
string

The first line of the building address.

addressLine2
string or null

The second line of the building address.

city
string

The name of the city that the building is in.

county
string or null

The name of the county that the building is in.

countryCode
string

The ISO 3166-1 alpha-2 country code that the building is in.

photo
string or null <uuid>

The UUID of the photo of the building.

createdAt
string <date-time>

The date and time that the building was created at.

modifiedAt
string <date-time>

The date and time that the building was last modified at.

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/buildings/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Building",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "name": "London Office",
  • "timeZone": "Europe/London",
  • "latitude": 51.509865,
  • "longitude": -0.118092,
  • "addressLine1": "20 Fenchurch Street",
  • "addressLine2": null,
  • "city": "London",
  • "county": null,
  • "countryCode": "GB",
  • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3",
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "modifiedAt": "2017-07-21T17:32:28+00:00"
}

Floor

Get a collection of floors

Get a list of all the floors within your company from all the buildings.

Authorizations:
oauth
query Parameters
buildingId
string
Example: buildingId=01CBCV1CT3BM8A52SEJ2J5F4EB

Filter by building identifier

page
integer >= 1
Example: page=1

The page of floors to get

itemsPerPage
integer [ 1 .. 500 ]
Example: itemsPerPage=30

Number of floors to get per page

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/floors/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "Floor",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Floor 01"
      }
    ],
  • "hydra:totalItems": 0
}

Get a single floor by identifier

Get a floor if you know it's identifier.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Floor identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/floors/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Floor",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "name": "Floor 01"
}

Neighborhood

Get neighborhoods

Get a list of all the neighborhoods within your company from all the floors.

Authorizations:
oauth
query Parameters
buildingId
string
Example: buildingId=01CBCV1CT3BM8A52SEJ2J5F4EB

Filter by building identifier

floorId
string
Example: floorId=01H57KGTPZ50STX5N62Q991JNM

Filter by floor identifier

page
integer >= 1
Example: page=1

The page of neighborhoods to get

itemsPerPage
integer [ 1 .. 500 ]
Example: itemsPerPage=30

Number of neighborhoods to get per page

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/neighborhoods/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "Neighborhood",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Sales"
      }
    ],
  • "hydra:totalItems": 0
}

Get a single neighborhood by identifier

Get a neighborhood if you know it's identifier.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Neighborhood identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/neighborhoods/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Neighborhood",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "name": "Sales"
}

Space

Get spaces

Get a list of all the spaces within your company from all the floors.

Authorizations:
oauth
query Parameters
page
integer >= 1
Example: page=1

The page of spaces to get

itemsPerPage
integer [ 1 .. 500 ]
Example: itemsPerPage=30

Number of spaces to get per page

neighborhoodId
string
Example: neighborhoodId=01AZMC4F598J6RRG449TRTRK20

Filter by neighborhood identifier

floorId
string
Example: floorId=01CBCV1CT3BM8A52SEJ2J5F4EB

Filter by floor identifier

buildingId
string
Example: buildingId=01H4E18A4C7K1GD4BEM9NCNJAW

Filter by building identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/spaces/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "Space",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "name": "Desk 01",
      • "type": "desk",
      • "floor": {
        • "@context": "string",
        • "@id": "string",
        • "@type": "string",
        • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
        • "name": "Floor 01"
        },
      • "neighborhood": {
        • "@context": "string",
        • "@id": "string",
        • "@type": "string",
        • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
        • "name": "Sales"
        },
      • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
      }
    ],
  • "hydra:totalItems": 0
}

Get a single space by identifier

Get a space if you know it's identifier.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

Space identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The ULID of the space.

https://schema.org/identifier
name
string

The name of the space.

type
string
Enum: "desk" "room"

The type of space.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

object,null
Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the neighborhood.

https://schema.org/identifier
name
string

The name of the neighborhood.

photo
string or null <uuid>

The UUID of the photo of the space.

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/spaces/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "Space",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "name": "Desk 01",
  • "type": "desk",
  • "floor": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Floor 01"
    },
  • "neighborhood": {
    • "@context": "string",
    • "@id": "string",
    • "@type": "string",
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Sales"
    },
  • "photo": "b74b830a-cf26-47bd-9dbc-237571c79fc3"
}

User

Get users

Get a list of all the users within your company.

Authorizations:
oauth
query Parameters
email
string
Example: email=john.smith@example.com

Filter users by email address

firstName
string
Example: firstName=John

Filter users by first name

lastName
string
Example: lastName=Smith

Filter users by last name

page
integer >= 1
Example: page=1

The page of users to get

itemsPerPage
integer [ 1 .. 500 ]
Example: itemsPerPage=30

Number of users to get per page

id
string
Example: id=01GTBV1CT3BM8A42SEJ2J5F4EG

User identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
required
Array of objects
Array
@id
string
@type
string
id
string <ulid>

The user's ULID within the Kadence platform.

https://schema.org/identifier
email
string <email>

The user's email address.

https://schema.org/email
firstName
string

The user's given name.

https://schema.org/givenName
lastName
string

The user's family name.

https://schema.org/familyName
jobTitle
string or null

The user's job title.

https://schema.org/jobTitle
invitationPending
boolean

Has the user signed up to use Kadence or is their invitation to join still pending?

object,null

The user's preferred floor for booking when going into the office.

Any of
string or object
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

createdAt
string <date-time>

The date and time of when the user was created.

https://schema.org/dateCreated
modifiedAt
string <date-time>

The date and time of when the user was last modified.

https://schema.org/dateModified
locale
string

A IETF language tag of the user's preferred locale.

timePreference
string
Enum: "default" "24H" "12H"

The user's preferred time format. default will follow the user's locale.

locationCityName
string or null

The city name of user's usual location.

locationCountryCode
string or null

The ISO 3166-1 alpha-2 country code of the user's usual location.

locationLatitude
number or null <float>

The latitude of the user's usual location, based on their city.

locationLongitude
number or null <float>

The longitude of the user's usual location, based on their city.

locationTimezone
string or null

The usual IANA time zone of the user, based on their city.

biography
string or null

A short biography.

monogram
string

A two letter identifier made from their full name or email address.

hydra:totalItems
integer >= 0

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    • {
      • "@id": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "@type": "User",
      • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
      • "email": "john.smith@example.com",
      • "firstName": "John",
      • "lastName": "Smith",
      • "jobTitle": "Head of Marketing",
      • "invitationPending": true,
      • "preferredFloor": {
        • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
        • "name": "Floor 1"
        },
      • "createdAt": "2017-07-21T17:32:28+00:00",
      • "modifiedAt": "2017-07-21T17:32:28+00:00",
      • "locale": "en-GB",
      • "timePreference": "default",
      • "locationCityName": "London",
      • "locationCountryCode": "GB",
      • "locationLatitude": 51.509865,
      • "locationLongitude": -0.118092,
      • "locationTimezone": "Europe/London",
      • "biography": "I love 🍕!",
      • "monogram": "JS"
      }
    ],
  • "hydra:totalItems": 0
}

Get a single user by identifier

Get a single user if you know their identifier.

Authorizations:
oauth
path Parameters
id
required
string
Example: 01GTBV1CT3BM8A42SEJ2J5F4EG

User identifier

header Parameters
Accept
required
string
Example: application/ld+json

Responses

Response Schema: application/ld+json
@id
string
@type
string
id
string <ulid>

The user's ULID within the Kadence platform.

https://schema.org/identifier
email
string <email>

The user's email address.

https://schema.org/email
firstName
string

The user's given name.

https://schema.org/givenName
lastName
string

The user's family name.

https://schema.org/familyName
jobTitle
string or null

The user's job title.

https://schema.org/jobTitle
invitationPending
boolean

Has the user signed up to use Kadence or is their invitation to join still pending?

object,null

The user's preferred floor for booking when going into the office.

Any of
string or object
One of
string
@id
string
@type
string
id
string <ulid>

The ULID of the floor.

https://schema.org/identifier
name
string

The name of the floor.

createdAt
string <date-time>

The date and time of when the user was created.

https://schema.org/dateCreated
modifiedAt
string <date-time>

The date and time of when the user was last modified.

https://schema.org/dateModified
locale
string

A IETF language tag of the user's preferred locale.

timePreference
string
Enum: "default" "24H" "12H"

The user's preferred time format. default will follow the user's locale.

locationCityName
string or null

The city name of user's usual location.

locationCountryCode
string or null

The ISO 3166-1 alpha-2 country code of the user's usual location.

locationLatitude
number or null <float>

The latitude of the user's usual location, based on their city.

locationLongitude
number or null <float>

The longitude of the user's usual location, based on their city.

locationTimezone
string or null

The usual IANA time zone of the user, based on their city.

biography
string or null

A short biography.

monogram
string

A two letter identifier made from their full name or email address.

Response samples

Content type
application/ld+json
{
  • "@id": "/v1/public/users/01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "@type": "User",
  • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
  • "email": "john.smith@example.com",
  • "firstName": "John",
  • "lastName": "Smith",
  • "jobTitle": "Head of Marketing",
  • "invitationPending": true,
  • "preferredFloor": {
    • "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
    • "name": "Floor 1"
    },
  • "createdAt": "2017-07-21T17:32:28+00:00",
  • "modifiedAt": "2017-07-21T17:32:28+00:00",
  • "locale": "en-GB",
  • "timePreference": "default",
  • "locationCityName": "London",
  • "locationCountryCode": "GB",
  • "locationLatitude": 51.509865,
  • "locationLongitude": -0.118092,
  • "locationTimezone": "Europe/London",
  • "biography": "I love 🍕!",
  • "monogram": "JS"
}