API Reference

Scalars

Roles

Common objects

Slots

Projects

Services

Bookings

Spaces

Locations

Assets

Team

Reviews

Reminders

Webhooks

Denylist

Schema

JS SDK

Timerise © 2024

Projects overview

Projects are independent collections of services, bookings, assets, locations and users.

Object types

Project

Represents information about a project, such as title, media and theme.

type Project {
	projectId: ID!
	shortId: NonEmptyString!
	defaultLocale: Locale!
	title: NonEmptyString!
	description: NonEmptyString
	theme: Theme!
	logoUrl: URL
	coverUrl: URL
	textColor: HexColorCode
	linkColor: HexColorCode
	buttonTextColor: HexColorCode
	buttonBackgroundColor: HexColorCode
	labels: [NonEmptyString]
	createdAt: DateTime!
	updatedAt: DateTime!
}

Project fields

Queries

projects

List of projects.

projects(
	limit: NonNegativeInt
	cursor: ID
): [Project]

projects arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

project

Returns a Project resource by ID.

project(
	projectId: ID!
): Project

project arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

Mutations

projectCreate

Create a new project.

projectCreate(
	title: NonEmptyString!
	defaultLocale: Locale
	description: NonEmptyString
	theme: Theme
	logoUrl: URL
	coverUrl: URL
	textColor: HexColorCode
	linkColor: HexColorCode
	buttonTextColor: HexColorCode
	buttonBackgroundColor: HexColorCode
	labels: [NonEmptyString]
): Projec

projectCreate arguments

<aside> 🔑 Minimal role required: SUPERADMIN

</aside>

projectUpdate

Updates a project's attributes.

projectUpdate(
	projectId: String!
	title: NonEmptyString
	defaultLocale: Locale
	description: NonEmptyString
	theme: Theme
	logoUrl: URL
	coverUrl: URL
	textColor: HexColorCode
	linkColor: HexColorCode
	buttonTextColor: HexColorCode
	buttonBackgroundColor: HexColorCode
	labels: [NonEmptyString]
): Project

projectUpdate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

projectDelete

Deletes a project.

projectDelete(
	projectId: ID!
): String

projectDelete arguments

<aside> 🔑 Minimal role required: ADMIN / APIADMIN

</aside>