API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
Locations overview
The locations can be an address or a specific place, e.g. a conference room.
Object types
Location
type Location {
projectId: ID!
locationId: ID!
shortId: NonEmptyString!
title: NonEmptyString!
description: NonEmptyString
address: NonEmptyString
latLng: LatLng
slots: [Slot]
media: [Media]
labels: [NonEmptyString]
createdAt: DateTime!
updatedAt: DateTime!
}| Field name | Value type | Non-null | Description |
|---|---|---|---|
projectId | ID | true | |
locationId | ID | true | |
shortId | ID | true | A human-readable identifier for the location. |
title | NonEmptyString | true | |
description | String | false | |
address | String | false | |
latLng | LatLng | false | |
slots | [Slot] | false | |
media | [Media] | 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. |
LocationSlotStrategy
type LocationSlotStrategy {
projectId: ID!
locationId: ID!
strategyId: ID!
strategyType: StrategyType!
discontinueStrategy: DiscontinueStrategy!
dateTimeFrom: DateTime
dateTimeTo: DateTime
timeFrom: Time
timeTo: Time
daysOfWeek: [DayOfWeek]
slotType: SlotType
slotQuantity: NonNegativeInt
slotDuration: Duration
slotInterval: Duration
createdAt: DateTime!
updatedAt: DateTime!
}| Field name | Value type | Non-null | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
strategyId | ID | true | A globally-unique identifier. |
strategyType | StrategyType | true | |
discontinueStrategy | DiscontinueStrategy | true | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
timeFrom | Time | false | |
timeTo | Time | false | |
daysOfWeek | [DayOfWeek] | false | |
slotType | SlotType | false | |
slotQuantity | NonNegativeInt | false | |
slotDuration | Duration | false | |
slotInterval | Duration | false | |
createdAt | DateTime | true | The date and time when an object was created. |
updatedAt | DateTime | true | The date and time when an object was updated. |
Queries
locations
locations(
projectId: ID!
limit: NonNegativeInt
cursor: ID
): [Location]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
limit | NonNegativeInt | false | |
cursor | ID | false |
Minimal role required:
STAFFlocationsSearch
locationsSearch(
projectId: ID!
query: String!
): [Location]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
query | String | true |
Minimal role required:
STAFFlocationSlotsStrategies
locationSlotsStrategies(
projectId: ID!
locationId: ID!
): [LocationSlotStrategy]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
Minimal role required:
ADMIN / APIADMINMutations
locationCreate
locationCreate(
projectId: ID!
title: NonEmptyString
description: NonEmptyString
address: NonEmptyString
latLng: LatLngInput
media: [MediaInput]
labels: [NonEmptyString]
): Location| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | |
locationId | ID | false | |
title | NonEmptyString | false | |
description | NonEmptyString | false | |
address | NonEmptyString | false | |
latLng | LatLngInput | false | |
media | [MediaInput] | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERlocationUpdate
locationUpdate(
projectId: ID!
locationId: String!
title: NonEmptyString
description: NonEmptyString
address: NonEmptyString
latLng: LatLngInput
media: [MediaInput]
labels: [NonEmptyString]
): Location| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | |
locationId | ID | true | |
title | NonEmptyString | false | |
description | NonEmptyString | false | |
address | NonEmptyString | false | |
latLng | LatLngInput | false | |
media | [MediaInput] | false | |
labels | [NonEmptyString] | false |
Minimal role required:
MANAGERlocationDelete
locationDelete(
projectId: ID!
locationId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERlocationSlotCreate
locationSlotCreate(
projectId: ID!
locationId: ID!
quantity: NonNegativeInt!
dateTimeFrom: DateTime!
dateTimeTo: DateTime!
slotType: SlotType!
slotGroupId: ID
title: String
): Slot| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
quantity | NonNegativeInt | true | |
dateTimeFrom | DateTime | true | |
dateTimeTo | DateTime | true | |
slotType | SlotType | true | |
slotGroupId | ID | false | A globally-unique identifier. |
title | String | false |
Minimal role required:
MANAGERlocationSlotUpdate
locationSlotUpdate(
projectId: ID!
locationId: ID!
slotId: String!
quantity: NonNegativeInt
dateTimeFrom: DateTime
dateTimeTo: DateTime
slotType: SlotType
title: String
slotGroupId: ID
): Slot| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
slotId | ID | true | A globally-unique identifier. |
quantity | NonNegativeInt | false | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
slotType | SlotType | false | |
title | String | false | |
slotGroupId | ID | false |
Minimal role required:
MANAGERlocationSlotDelete
locationSlotDelete(
projectId: ID!
locationId: ID!
slotId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
slotId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERlocationSlotStrategyCreate
locationSlotStrategyCreate(
projectId: ID!
locationId: ID!
slotType: SlotType!
slotQuantity: NonNegativeInt!
slotDuration: Duration!
slotInterval: Duration!
strategyType: StrategyType!
discontinueStrategy: DiscontinueStrategyInput!
daysOfWeek: [DayOfWeek!]
dateTimeFrom: DateTime
dateTimeTo: DateTime
timeFrom: Time
timeTo: Time
): LocationSlotStrategy| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
slotType | NonNegativeInt | true | |
slotQuantity | ID | true | A globally-unique identifier. |
slotDuration | Duration | true | |
slotInterval | Duration | true | |
strategyType | StrategyType | true | |
discontinueStrategy | DiscontinueStrategyInput | true | |
daysOfWeek | [DayOfWeek] | true | |
dateTimeFrom | DateTime | false | |
dateTimeTo | DateTime | false | |
timeFrom | Time | false | |
timeTo | Time | false |
Minimal role required:
ADMIN / APIADMINlocationSlotStrategyDelete
Deletes a strategy.
locationSlotStrategyDelete(
projectId: ID!
locationId: ID!
strategyId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
locationId | ID | true | A globally-unique identifier. |
strategyId | ID | true | A globally-unique identifier. |
Minimal role required:
ADMIN / APIADMIN