API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
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!
}| Field name | Value type | Non-null | Description |
|---|---|---|---|
projectId | ID | true | A unique identifier for the project. |
shortId | NonEmptyString | true | A human-readable identifier for the project. |
defaultLocale | Local | true | |
title | NonEmptyString | true | |
description | NonEmptyString | false | |
theme | Theme | true | |
logoUrl | URL | false | |
coverUrl | URL | false | |
textColor | HexColorCode | false | |
linkColor | HexColorCode | false | |
buttonTextColor | HexColorCode | false | |
buttonBackgroundColor | HexColorCode | false | |
labels | [NonEmptyString] | false | |
createdAt | DateTime | true | The date and time when a project was created. |
updatedAt | DateTime | true | The date and time when a project was updated. |
Queries
projects
List of projects.
projects(
limit: NonNegativeInt
cursor: ID
): [Project]Minimal role required:
STAFFproject
Returns a Project resource by ID.
project(
projectId: ID!
): Project| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A unique identifier for the project. |
Minimal role required:
STAFFMutations
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| Field name | Value type | Required | Description |
|---|---|---|---|
title | NonEmptyString | true | |
defaultLocale | Locale | false | |
description | NonEmptyString | false | |
theme | Theme | false | |
logoUrl | URL | false | |
coverUrl | URL | false | |
textColor | HexColorCode | false | |
linkColor | HexColorCode | false | |
buttonTextColor | HexColorCode | false | |
buttonBackgroundColor | HexColorCode | false | |
labels | [NonEmptyString] | false |
Minimal role required:
SUPERADMINprojectUpdate
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| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A unique identifier for the project. |
title | NonEmptyString | false | |
defaultLocale | Locale | false | |
description | NonEmptyString | false | |
theme | Theme | false | |
logoUrl | URL | false | |
coverUrl | URL | false | |
textColor | HexColorCode | false | |
linkColor | HexColorCode | false | |
buttonTextColor | HexColorCode | false | |
buttonBackgroundColor | HexColorCode | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERprojectDelete
Deletes a project.
projectDelete(
projectId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A unique identifier for the project. |
Minimal role required:
ADMIN / APIADMIN