API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
Bookings overview
Object types
Bookings
type Booking {
bookingId: ID
shortId: NonEmptyString
project: Project
service: Service
slots: [Slot]
slotLockUpDateTime: DateTime
reminders: [Reminder]
status: BookingStatus
dateTimeFrom: DateTime
dateTimeTo: DateTime
duration: Duration
phoneNumber: PhoneNumber
emailAddress: EmailAddress
fullName: NonEmptyString
comment: NonEmptyString
shortUrl: URL
qrUrl: URL
iCalUrl: URL
createdAt: DateTime
updatedAt: DateTime
}
Field name | Value type | Non-null | Description |
---|---|---|---|
bookingId | ID | true | A globally-unique identifier. |
shortId | NonEmptyString | false | |
project | Project | false | |
service | Service | false | |
slots | Slot | false | |
slotLockUpDateTime | DateTime | false | |
reminders | Reminder | false | |
status | BookingStatus | false | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
duration | Duration | false | |
shortUrl | URL | false | |
qrUrl | URL | false | |
iCalUrl | URL | false | |
createdAt | DateTime | false | The date and time when a booking was created. |
updatedAt | DateTime | false | The date and time when a booking was updated. |
Enums
BookingStatus
enum BookingStatus {
DRAFT
NEW
CONFIRMED
ACCEPTED
RENEWED
REJECTED
CANCELED
}
Valid value | Description |
---|---|
DRAFT | Lorem ipsum |
NEW | Lorem ipsum |
CONFIRMED | Lorem ipsum |
ACCEPTED | Lorem ipsum |
RENEWED | Lorem ipsum |
REJECTED | Lorem ipsum |
CANCELED | Lorem ipsum |
Queries
bookings
bookings(
projectId: ID!
locationId: ID
assetId: ID
hostId: ID
serviceId: ID
status: BookingStatus
dateTimeFrom: DateTime
dateTimeTo: DateTime
limit: NonNegativeInt
cursor: ID
): [Booking]
Field name | Value type | Required | Description |
---|---|---|---|
projectId | ID | True | A globally-unique identifier. |
locationID | ID | False | |
assetID | ID | False | |
hostID | ID | False | |
serviceID | ID | False | |
status | BookingStatus | False | |
dateTimeFrom | DateTime | False | |
dateTimeTo | DateTime | False | |
limit | NonNegativeInt | False | |
cursor | ID | False |
Minimal role required:
STAFF
bookingSearch
bookingsSearch(
projectId: ID!
query: String!
locationId: ID
assetId: ID
hostId: ID
serviceId: ID
status: BookingStatus
dateTimeFrom: DateTime
dateTimeTo: DateTime
): [Booking]
Field name | Value type | Required | Description |
---|---|---|---|
projectId | ID | True | A globally-unique identifier. |
query | String | True | |
locationId | ID | False | |
assetId | ID | False | |
serviceId | ID | False | |
status | BookingStatus | False | |
dateTimeFrom | DateTime | False | |
dateTimeTo | DateTime | False |
Minimal role required:
STAFF
booking
booking(
bookingId: ID!
): Booking
Field name | Value type | Required | Description |
---|---|---|---|
bookingId | ID | True | A globally-unique identifier. |
Minimal role required:
USER
Mutations
bookingCreate
bookingCreate(
serviceId: ID!
slotId: ID!
emailAddress: EmailAddress
phoneNumber: PhoneNumber
fullName: NonEmptyString
comment: NonEmptyString
): Booking
Field name | Value type | Required | Description |
---|---|---|---|
serviceId | ID | True | A globally-unique identifier. |
slotId | ID | True | |
emailAddress | EmailAddress | False | |
phoneNumber | PhoneNumber | False | |
fullName | String | False | |
comment | String | False |
Minimal role required:
USER
bookingConfirm
bookingConfirm(
bookingId: ID!
): Booking
Field name | Value type | Required | Description |
---|---|---|---|
bookingId | ID | True | A globally-unique identifier. |
Minimal role required:
USER
bookingRenew
bookingRenew(
bookingId: ID!
): Booking
Field name | Value type | Required | Description |
---|---|---|---|
bookingId | ID | True | A globally-unique identifier. |
Minimal role required:
USER
bookingCancel
bookingCancel(
bookingId: ID!
): Booking
Field name | Value type | Required | Description |
---|---|---|---|
bookingId | ID | True | A globally-unique identifier. |
Minimal role required:
USER
Subscriptions
booking
booking(
bookingId: ID!
): Booking
Field name | Value type | Required | Description |
---|---|---|---|
bookingId | ID | True | A globally-unique identifier. |
Minimal role required:
USER