API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
Spaces overview
Object types
Space
type Space {
projectId: ID!
spaceId: ID!
shortId: NonEmptyString!
provider: SpaceProvider!
url: URL!
title: String!
instructions: String!
labels: [NonEmptyString]
createdAt: DateTime!
updatedAt: DateTime!
}| Field name | Value type | Non-null | Description |
|---|---|---|---|
projectId | ID | true | |
spaceId | ID | true | |
shortId | ID | true | A human-readable identifier for the location. |
title | NonEmptyString | true | |
instructions | String | false | |
labels | [NonEmptyString] | false | |
createdAt | DateTime | true | The date and time when a location was created. |
updatedAt | DateTime | true | The date and time when a location was updated. |
Queries
spaces
spaces(
projectId: ID!
limit: NonNegativeInt
cursor: ID
): [Space]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
limit | NonNegativeInt | false | |
cursor | ID | false |
Minimal role required:
STAFFMutations
spaceCreate
spaceCreate(
projectId: ID!
provider: SpaceProvider!
url: URL!
title: String
instructions: String
labels: [NonEmptyString]
): Space| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | |
provider | SpaceProvider | true | |
url | URL | true | |
title | String | false | |
instructions | String | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERspaceUpdate
spaceUpdate(
projectId: ID!
spaceId: String!
provider: SpaceProvider!
url: URL!
title: NonEmptyString
instructions: NonEmptyString
labels: [NonEmptyString]
): Space| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | |
spaceId | ID | true | |
provider | SpaceProvider | true | |
url | URL | true | |
title | String | false | |
instructions | String | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERspaceDelete
spaceDelete(
projectId: ID!
spaceId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
spaceId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGER