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.
Get a single booking if you know it's identifier.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG Booking identifier |
Accept required | string Example: application/ld+json |
@id | string | ||||||||||||||||||||||||||||||||||||||||||||||||
@type | string | ||||||||||||||||||||||||||||||||||||||||||||||||
id | |||||||||||||||||||||||||||||||||||||||||||||||||
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 whose booking it is. | ||||||||||||||||||||||||||||||||||||||||||||||||
object,null | |||||||||||||||||||||||||||||||||||||||||||||||||
Any of
| |||||||||||||||||||||||||||||||||||||||||||||||||
startDate | string or null <date-time> The date and time the booking starts at. | ||||||||||||||||||||||||||||||||||||||||||||||||
endDate | string or null <date-time> The date and time the booking ends at. | ||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||
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> If auto released, 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. |
{- "@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",
- "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 into 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.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG Booking identifier |
Accept required | string Example: application/ld+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. |
@id | string | ||||||||||||||||||||||||||||||||||||||||||||||||
@type | string | ||||||||||||||||||||||||||||||||||||||||||||||||
id | |||||||||||||||||||||||||||||||||||||||||||||||||
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 whose booking it is. | ||||||||||||||||||||||||||||||||||||||||||||||||
object,null | |||||||||||||||||||||||||||||||||||||||||||||||||
Any of
| |||||||||||||||||||||||||||||||||||||||||||||||||
startDate | string or null <date-time> The date and time the booking starts at. | ||||||||||||||||||||||||||||||||||||||||||||||||
endDate | string or null <date-time> The date and time the booking ends at. | ||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||
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> If auto released, 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. |
{- "userId": "01GTBV1CT3BM8A42SEJ2J5F4EG",
- "method": "doorAccess"
}
{- "@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",
- "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 list of all the bookings made by a user.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG User identifier |
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. |
startDate | string Example: startDate=2023-01-01 Booking start date in format YYYY-MM-DD |
endDate | string Example: endDate=2023-01-02 Booking end date in format YYYY-MM-DD |
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 |
Accept required | string Example: application/ld+json |
required | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hydra:totalItems | integer >= 0 |
{- "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": {
- "@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",
- "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
}
Get a list of all the buildings within your company.
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 |
Accept required | string Example: application/ld+json |
required | Array of objects | ||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
hydra:totalItems | integer >= 0 |
{- "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 if you know it's identifier.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG Building identifier |
Accept required | string Example: application/ld+json |
@id | string |
@type | string |
id | |
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. |
{- "@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"
}
Get a list of all the floors within your company from all the buildings.
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 |
Accept required | string Example: application/ld+json |
required | Array of objects | ||||||||
Array
| |||||||||
hydra:totalItems | integer >= 0 |
{- "hydra:member": [
- {
- "@id": "/v1/public/floors/01GTBV1CT3BM8A42SEJ2J5F4EG",
- "@type": "Floor",
- "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
- "name": "Floor 01"
}
], - "hydra:totalItems": 0
}
Get a floor if you know it's identifier.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG Floor identifier |
Accept required | string Example: application/ld+json |
@id | string |
@type | string |
id | |
name | string The name of the floor. |
{- "@id": "/v1/public/floors/01GTBV1CT3BM8A42SEJ2J5F4EG",
- "@type": "Floor",
- "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
- "name": "Floor 01"
}
Get a list of all the neighborhoods within your company from all the floors.
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 |
Accept required | string Example: application/ld+json |
required | Array of objects | ||||||||
Array
| |||||||||
hydra:totalItems | integer >= 0 |
{- "hydra:member": [
- {
- "@id": "/v1/public/neighborhoods/01GTBV1CT3BM8A42SEJ2J5F4EG",
- "@type": "Neighborhood",
- "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
- "name": "Sales"
}
], - "hydra:totalItems": 0
}
Get a neighborhood if you know it's identifier.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG Neighborhood identifier |
Accept required | string Example: application/ld+json |
@id | string |
@type | string |
id | |
name | string The name of the neighborhood. |
{- "@id": "/v1/public/neighborhoods/01GTBV1CT3BM8A42SEJ2J5F4EG",
- "@type": "Neighborhood",
- "id": "01GTBV1CT3BM8A42SEJ2J5F4EG",
- "name": "Sales"
}
Get a list of all the spaces within your company from all the floors.
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 |
Accept required | string Example: application/ld+json |
required | Array of objects | ||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||
hydra:totalItems | integer >= 0 |
{- "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 space if you know it's identifier.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG Space identifier |
Accept required | string Example: application/ld+json |
@id | string | ||||||||||||
@type | string | ||||||||||||
id | |||||||||||||
name | string The name of the space. | ||||||||||||
type | string Enum: "desk" "room" The type of space. | ||||||||||||
object,null | |||||||||||||
Any of
| |||||||||||||
object,null | |||||||||||||
Any of
| |||||||||||||
photo | string or null <uuid> The UUID of the photo of the space. |
{- "@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"
}
Get a list of all the users within your company.
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 |
Accept required | string Example: application/ld+json |
required | Array of objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
hydra:totalItems | integer >= 0 |
{- "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 if you know their identifier.
id required | string Example: 01GTBV1CT3BM8A42SEJ2J5F4EG User identifier |
Accept required | string Example: application/ld+json |
@id | string | ||||||||||||
@type | string | ||||||||||||
id | |||||||||||||
firstName | |||||||||||||
lastName | |||||||||||||
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
| |||||||||||||
createdAt | |||||||||||||
modifiedAt | string <date-time> The date and time of when the user was last modified. | ||||||||||||
locale | string A IETF language tag of the user's preferred locale. | ||||||||||||
timePreference | string Enum: "default" "24H" "12H" The user's preferred time format. | ||||||||||||
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. |
{- "@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"
}