API Reference

Scalars

Roles

Common objects

Slots

Projects

Services

Bookings

Spaces

Locations

Assets

Team

Reviews

Reminders

Webhooks

Denylist

Schema

JS SDK

Timerise © 2024

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!
}

Location fields

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](<https://timerise.notion.site/DateTime-d906acb0a1e4492ab960a2fa5d4650ab>)!
	updatedAt: [DateTime](<https://timerise.notion.site/DateTime-d906acb0a1e4492ab960a2fa5d4650ab>)!
}

LocationSlotStrategy fields

Queries

locations

locations(
	projectId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
	limit: [NonNegativeInt](<https://timerise.notion.site/NonNegativeInt-04116d7c1f2a47fb82756b93ba6d0d50>)
	cursor: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)
): [Location]

locations arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

locationsSearch

location**sSearch**(
	projectId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
	query: String!
): [Location]

locationsSearch arguments

<aside> 🔑 Minimal role required: STAFF

</aside>

locationSlotsStrategies

location**SlotsStrategies**(
	projectId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
	locationId: [ID](<https://timerise.notion.site/ID-6767ab390c014c1e995e1f45057b801e>)!
): [LocationSlotStrategy]

locationSlotsStrategies arguments

<aside> 🔑 Minimal role required: ADMIN / APIADMIN

</aside>

Mutations

locationCreate

locationCreate(
	projectId: ID!
	title: NonEmptyString
	description: NonEmptyString
	address: NonEmptyString
	latLng: LatLngInput
	media: [MediaInput]
	labels: [NonEmptyString]
): Location

locationCreate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

locationUpdate

locationUpdate(
	projectId: ID!
	locationId: String!
	title: NonEmptyString
	description: NonEmptyString
	address: NonEmptyString
	latLng: LatLngInput
	media: [MediaInput]
	labels: [NonEmptyString]
): Location

locationUpdate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

locationDelete

locationDelete(
	projectId: ID!
	locationId: ID!
): String

locationDelete arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

locationSlotCreate

locationSlotCreate(
	projectId: ID!
	locationId: ID!
	quantity: NonNegativeInt!
	dateTimeFrom: DateTime!
	dateTimeTo: DateTime!
	slotType: SlotType!
	slotGroupId: ID
	title: String
): Slot

locationSlotCreate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

locationSlotUpdate

locationSlotUpdate(
	projectId: ID!
	locationId: ID!
	slotId: String!
	quantity: NonNegativeInt
	dateTimeFrom: DateTime
	dateTimeTo: DateTime
	slotType: SlotType
	title: String
	slotGroupId: ID
): Slot

locationSlotUpdate arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

locationSlotDelete

locationSlotDelete(
	projectId: ID!
	locationId: ID!
	slotId: ID!
): String

locationSlotDelete arguments

<aside> 🔑 Minimal role required: MANAGER

</aside>

locationSlotStrategyCreate

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

locationSlotStrategyCreate arguments

<aside> 🔑 Minimal role required: ADMIN / APIADMIN

</aside>

locationSlotStrategyDelete

Deletes a strategy.

locationSlotStrategyDelete(
	projectId: ID!
	locationId: ID!
	strategyId: ID!
): String

locationSlotStrategyDelete arguments

<aside> 🔑 Minimal role required: ADMIN / APIADMIN

</aside>