API Reference

Scalars

Roles

Common objects

Slots

Projects

Services

Bookings

Spaces

Locations

Assets

Team

Reviews

Reminders

Webhooks

Denylist

Schema

JS SDK

Timerise © 2024

Bookings overview

Booking is a reserved time slot. You can reserve a slot on the booking page of a specific service.

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
}

Booking fields

Enums

BookingStatus

enum BookingStatus {
	DRAFT
	NEW
	CONFIRMED
	ACCEPTED
	RENEWED
	REJECTED
	CANCELED
}

BookingStatus valid values

Queries

bookings

bookings(
	projectId: ID!
	locationId: ID
	assetId: ID
	hostId: ID
	serviceId: ID
	status: BookingStatus
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
	limit: NonNegativeInt
	cursor: ID
): [Booking]

bookings arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

bookingSearch

bookingsSearch(
	projectId: ID!
	query: String!
	locationId: ID
	assetId: ID
	hostId: ID
	serviceId: ID
	status: BookingStatus
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
): [Booking]

bookingSearch arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

booking

booking(
	bookingId: ID!
): Booking

booking arguments

<aside> 🔑 Minimal role required: USER

</aside>

Mutations

bookingCreate

bookingCreate(
	serviceId: ID!
	slotId: ID!
	emailAddress: EmailAddress
	phoneNumber: PhoneNumber
	fullName: NonEmptyString
	comment: NonEmptyString
): Booking

bookingCreate arguments

<aside> 🔑 Minimal role required: USER

</aside>

bookingConfirm

bookingConfirm(
	bookingId: ID!
): Booking

bookingConfirm arguments

<aside> 🔑 Minimal role required: USER

</aside>

bookingRenew

bookingRenew(
	bookingId: ID!
): Booking

bookingRenew arguments

<aside> 🔑 Minimal role required: USER

</aside>

bookingCancel

bookingCancel(
	bookingId: ID!
): Booking

bookingCancel arguments

<aside> 🔑 Minimal role required: USER

</aside>

Subscriptions

booking

booking(
	bookingId: ID!
): Booking

booking arguments

<aside> 🔑 Minimal role required: USER

</aside>