API Reference

Common objects overview

List of available objects and queries related to many API resources.

Object types

User

Represents details of a user.

type User {
	userId: ID!
	projectId: ID!
	shortId: NonEmptyString!
	slots: [Slot]
	role: UserRole!
	email: EmailAddress!
	phoneNumber: PhoneNumber
	fullName: NonEmptyString
	jobTitle: NonEmptyString
	photoUrl: URL
	createdAt: DateTime!
	updatedAt: DateTime!
}

User fields

Media

Represents details of a media object.

type Media {
	url: URL!
	title: NonEmptyString
}

Media fields

LatLng

Represents details of a LatLng object.

type LatLng {
	lat: Latitude!
	lng: Longitude!
}

LatLng fields

Enums

UserRole

User roles available in the system.

enum UserRole {
	SUPERADMIN
	OWNER
	ADMIN
	APIADMIN
	MANAGER
	STAFF
	USER
}

UserRole valid values

Theme

Represents details of a Theme.

enum Theme {
	LIGHT
	DARK
}

Theme valid values

Queries

me

Returns a me object.

me(
	projectId: ID!
): User

me arguments

<aside> 🔑 Minimal role required: USER

</aside>

Mutations

login

Get auth token. Needed to sign all other API queries.

login(
	email: EmailAddress!
	password: NonEmptyString!
): String

<aside> 🔑 Minimal role required: USER

</aside>