Camelo GraphQL API Reference
Welcome to the Camelo GraphQL API reference! This reference includes the complete set of GraphQL types, queries, mutations, and their parameters for interacting with our API. For more tutorial-oriented API documentation, please check out our API Guide.
Terms of Service
API Endpoints
# Production:
https://api.camelohq.com/graphql
Headers
# User JWT Token
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
abilities
Response
Returns an Abilities!
Example
Query
query abilities {
abilities {
currentSubscriptions {
features
id
state
subscriptionItems {
...SubscriptionItemFragment
}
subscriptionPlans {
...SubscriptionPlanFragment
}
trialEndAt
}
policyMatrix {
evaluator
id
policy
}
roles {
code
description
id
name
rolesUsers {
...RolesUserFragment
}
}
rolesUsers {
id
metaData {
...RoleMetaDataFragment
}
role {
...RoleFragment
}
user {
...UserFragment
}
}
scheduleIds
}
}
Response
{
"data": {
"abilities": {
"currentSubscriptions": [SubscriptionModel],
"policyMatrix": [PolicyMatrixItem],
"roles": [Role],
"rolesUsers": [RolesUser],
"scheduleIds": ["xyz789"]
}
}
}
allow
Description
Check policy permission for the current authorization context
Response
Returns a Boolean!
Example
Query
query allow(
$policyAction: String!,
$recordGid: String
) {
allow(
policyAction: $policyAction,
recordGid: $recordGid
)
}
Variables
{
"policyAction": "abc123",
"recordGid": "abc123"
}
Response
{"data": {"allow": false}}
appNotifications
Description
Lists all notifications of the current user
Response
Returns an AppNotificationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
type - AppNotificationTypeEnum
|
Example
Query
query appNotifications(
$after: String,
$before: String,
$first: Int,
$last: Int,
$type: AppNotificationTypeEnum
) {
appNotifications(
after: $after,
before: $before,
first: $first,
last: $last,
type: $type
) {
edges {
cursor
node {
...AppNotificationFragment
}
}
nodes {
blocks
createdAt
id
read
text
type
updatedAt
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 987,
"last": 987,
"type": "CAMELO_UPDATES"
}
Response
{
"data": {
"appNotifications": {
"edges": [AppNotificationEdge],
"nodes": [AppNotification],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
apps
Description
Lists all apps from a workspace
Response
Returns an AppConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query apps(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
apps(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
cursor
node {
...AppFragment
}
}
nodes {
appModule
backgroundColor
description
emojiIcon
id
name
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"last": 987
}
Response
{
"data": {
"apps": {
"edges": [AppEdge],
"nodes": [App],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
attendanceNoticesReport
Description
Get attendance notices
Response
Returns [AttendanceNotice!]!
Arguments
| Name | Description |
|---|---|
filter - AttendanceNoticesReportFilter!
|
Example
Query
query attendanceNoticesReport($filter: AttendanceNoticesReportFilter!) {
attendanceNoticesReport(filter: $filter) {
punch {
atTime
attachment {
...TimeCardPunchAttachmentFragment
}
createdAt
id
note
punchType
timeCardId
updatedAt
warnings {
...TimeCardPunchWarningFragment
}
}
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"filter": AttendanceNoticesReportFilter}
Response
{
"data": {
"attendanceNoticesReport": [
{
"punch": TimeCardPunch,
"user": User
}
]
}
}
availabilities
Description
Lists all availabilities of a workspace
Response
Returns an AvailabilityConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - AvailabilityFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query availabilities(
$after: String,
$before: String,
$filter: AvailabilityFilter,
$first: Int,
$last: Int
) {
availabilities(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...AvailabilityFragment
}
}
nodes {
allDay
createdAt
from
id
note
recurrence {
...RecurrenceFragment
}
timezone
to
type
updatedAt
user {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filter": AvailabilityFilter,
"first": 123,
"last": 987
}
Response
{
"data": {
"availabilities": {
"edges": [AvailabilityEdge],
"nodes": [Availability],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
availability
Description
Get an availability detail
Response
Returns an Availability
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query availability($id: ID!) {
availability(id: $id) {
allDay
createdAt
from
id
note
recurrence {
id
rrule
timezone
}
timezone
to
type
updatedAt
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"availability": {
"allDay": false,
"createdAt": ISO8601DateTime,
"from": ISO8601DateTime,
"id": 4,
"note": "xyz789",
"recurrence": Recurrence,
"timezone": "abc123",
"to": ISO8601DateTime,
"type": "PREFERRED_WORKING_TIME",
"updatedAt": ISO8601DateTime,
"user": User
}
}
}
calendarEvents
Description
Lists all calendar events of a workspace
Response
Returns a CalendarEventConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - CalendarEventFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query calendarEvents(
$after: String,
$before: String,
$filter: CalendarEventFilter,
$first: Int,
$last: Int
) {
calendarEvents(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...CalendarEventFragment
}
}
nodes {
allDay
createdAt
creator {
...UserFragment
}
eventType
from
id
note
recurrence {
...RecurrenceFragment
}
schedules {
...ScheduleFragment
}
state
timezone
to
updatedAt
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"filter": CalendarEventFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"calendarEvents": {
"edges": [CalendarEventEdge],
"nodes": [CalendarEvent],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
channel
Description
Get a channel detail
Response
Returns a ChatChannel
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query channel($id: ID!) {
channel(id: $id) {
archivedAt
channelType
chatMessagesCount
color
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
currentMember {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
purpose
readOnly
suggested
users {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"channel": {
"archivedAt": ISO8601DateTime,
"channelType": "DIRECT",
"chatMessagesCount": 987,
"color": "abc123",
"creator": User,
"currentMember": ChannelMember,
"displayName": "xyz789",
"emojiIcon": "abc123",
"id": 4,
"lastAddedMessageContent": "abc123",
"lastMessageAt": ISO8601DateTime,
"members": [ChannelMember],
"purpose": "xyz789",
"readOnly": false,
"suggested": true,
"users": [User],
"workspace": Workspace
}
}
}
channelMember
Description
Get a channel member detail of the current user
Response
Returns a ChannelMember
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query channelMember($id: ID!) {
channelMember(id: $id) {
chatChannel {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
muted
notification
}
role
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"channelMember": {
"chatChannel": ChatChannel,
"id": 4,
"lastViewedAt": ISO8601DateTime,
"lastViewedMessagesCount": 123,
"mentionCount": 987,
"notifyProps": ChannelMemberNotifyProps,
"role": "ADMIN",
"user": User,
"workspace": Workspace
}
}
}
channels
Description
Lists all channels based on the given filter
Response
Returns a ChatChannelConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - ChannelFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query channels(
$after: String,
$before: String,
$filter: ChannelFilter,
$first: Int,
$last: Int
) {
channels(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...ChatChannelFragment
}
}
nodes {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"filter": ChannelFilter,
"first": 123,
"last": 987
}
Response
{
"data": {
"channels": {
"edges": [ChatChannelEdge],
"nodes": [ChatChannel],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
channelsInvitableUsers
Description
Lists all relevant users for inviting to a channel
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
channelId - ID!
|
|
first - Int
|
Returns the first n elements from the list. |
keyword - String
|
|
last - Int
|
Returns the last n elements from the list. |
Example
Query
query channelsInvitableUsers(
$after: String,
$before: String,
$channelId: ID!,
$first: Int,
$keyword: String,
$last: Int
) {
channelsInvitableUsers(
after: $after,
before: $before,
channelId: $channelId,
first: $first,
keyword: $keyword,
last: $last
) {
edges {
cursor
node {
...UserFragment
}
}
nodes {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"channelId": 4,
"first": 987,
"keyword": "abc123",
"last": 987
}
Response
{
"data": {
"channelsInvitableUsers": {
"edges": [UserEdge],
"nodes": [User],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
channelsMembers
Description
Lists all joined channels of the current user
Response
Returns [ChannelMember!]!
Example
Query
query channelsMembers {
channelsMembers {
chatChannel {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
muted
notification
}
role
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Response
{
"data": {
"channelsMembers": [
{
"chatChannel": ChatChannel,
"id": "4",
"lastViewedAt": ISO8601DateTime,
"lastViewedMessagesCount": 123,
"mentionCount": 987,
"notifyProps": ChannelMemberNotifyProps,
"role": "ADMIN",
"user": User,
"workspace": Workspace
}
]
}
}
checklist
Description
Get checklist detail
Example
Query
query checklist($id: ID!) {
checklist(id: $id) {
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
id
name
tasks {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
template
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"checklist": {
"creator": User,
"id": 4,
"name": "xyz789",
"tasks": [Task],
"template": false,
"workspace": Workspace
}
}
}
checklistAssignments
Description
Lists all checklist assignments the current user can view
Response
Returns [ChecklistAssignment!]!
Arguments
| Name | Description |
|---|---|
filter - ChecklistAssignmentFilter
|
Example
Query
query checklistAssignments($filter: ChecklistAssignmentFilter) {
checklistAssignments(filter: $filter) {
assignable {
... on Group {
...GroupFragment
}
... on JobSite {
...JobSiteFragment
}
... on Schedule {
...ScheduleFragment
}
... on Shift {
...ShiftFragment
}
}
checklist {
creator {
...UserFragment
}
id
name
tasks {
...TaskFragment
}
template
workspace {
...WorkspaceFragment
}
}
collaborationMode
completionPercentage
date
id
recurrence {
id
rrule
timezone
}
}
}
Variables
{"filter": ChecklistAssignmentFilter}
Response
{
"data": {
"checklistAssignments": [
{
"assignable": Group,
"checklist": Checklist,
"collaborationMode": "COLLABORATIVE",
"completionPercentage": 987,
"date": ISO8601DateTime,
"id": "4",
"recurrence": Recurrence
}
]
}
}
checklists
Description
Lists all checklists the current user can view
Response
Returns [Checklist!]!
Arguments
| Name | Description |
|---|---|
filter - ChecklistFilter
|
Example
Query
query checklists($filter: ChecklistFilter) {
checklists(filter: $filter) {
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
id
name
tasks {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
template
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"filter": ChecklistFilter}
Response
{
"data": {
"checklists": [
{
"creator": User,
"id": "4",
"name": "abc123",
"tasks": [Task],
"template": true,
"workspace": Workspace
}
]
}
}
comments
Description
Lists all comments of a commentable
Response
Returns a CommentConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
commentableId - ID!
|
|
commentableType - CommentableTypeEnum!
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query comments(
$after: String,
$before: String,
$commentableId: ID!,
$commentableType: CommentableTypeEnum!,
$first: Int,
$last: Int
) {
comments(
after: $after,
before: $before,
commentableId: $commentableId,
commentableType: $commentableType,
first: $first,
last: $last
) {
edges {
cursor
node {
...CommentFragment
}
}
nodes {
author {
...UserFragment
}
commentableId
commentableType
content
createdAt
data {
...CommentDataEntryFragment
}
id
pinnedAt
reactions {
...ReactionFragment
}
systemGenerated
visibility
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"commentableId": "4",
"commentableType": "CLIENT",
"first": 123,
"last": 123
}
Response
{
"data": {
"comments": {
"edges": [CommentEdge],
"nodes": [Comment],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
dashboardOverview
Description
Get data report for owner
Response
Returns a Dashboard!
Arguments
| Name | Description |
|---|---|
filter - DashboardOverviewFilter
|
Example
Query
query dashboardOverview($filter: DashboardOverviewFilter) {
dashboardOverview(filter: $filter) {
mostAbsent {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
mostLate {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
mostLeaveDays {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
mostReliable {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"filter": DashboardOverviewFilter}
Response
{
"data": {
"dashboardOverview": {
"mostAbsent": User,
"mostLate": User,
"mostLeaveDays": User,
"mostReliable": User
}
}
}
directChannel
Description
Get the direct channel with a recipient
Response
Returns a ChannelMember
Arguments
| Name | Description |
|---|---|
recipientId - ID!
|
Example
Query
query directChannel($recipientId: ID!) {
directChannel(recipientId: $recipientId) {
chatChannel {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
muted
notification
}
role
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"recipientId": "4"}
Response
{
"data": {
"directChannel": {
"chatChannel": ChatChannel,
"id": 4,
"lastViewedAt": ISO8601DateTime,
"lastViewedMessagesCount": 987,
"mentionCount": 123,
"notifyProps": ChannelMemberNotifyProps,
"role": "ADMIN",
"user": User,
"workspace": Workspace
}
}
}
document
Description
Get document detail
Example
Query
query document($id: ID!) {
document(id: $id) {
acknowledgementRequired
acknowledgements {
acknowledgeable {
... on Document {
...DocumentFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
}
acknowledgedAt
createdAt
deletedAt
id
updatedAt
user {
...UserFragment
}
}
allUsersAssigned
archived
assignedGroups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
assignees {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
assignmentType
color
createdAt
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
deletedAt
documentAttachments {
attachment
createdAt
documentId
id
updatedAt
}
expiredAt
folder {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
}
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"document": {
"acknowledgementRequired": false,
"acknowledgements": [Acknowledgement],
"allUsersAssigned": true,
"archived": false,
"assignedGroups": [Group],
"assignees": [User],
"assignmentType": "PERSONAL",
"color": "xyz789",
"createdAt": ISO8601DateTime,
"creator": User,
"deletedAt": ISO8601DateTime,
"documentAttachments": [DocumentAttachment],
"expiredAt": ISO8601DateTime,
"folder": Folder,
"id": 4,
"name": "abc123",
"notes": "abc123",
"pinnedAt": ISO8601DateTime,
"shareWithNewHires": true,
"state": "DRAFT",
"tags": [Tag],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
documents
Description
Lists all documents from a workspace
Response
Returns a DocumentConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - DocumentFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query documents(
$after: String,
$before: String,
$filter: DocumentFilter,
$first: Int,
$last: Int
) {
documents(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...DocumentFragment
}
}
nodes {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"filter": DocumentFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"documents": {
"edges": [DocumentEdge],
"nodes": [Document],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
employeeGetStartedSteps
Description
Lists all get started steps of the current user, if role is employee
Response
Returns [EmployeeGetStartedStep!]!
Example
Query
query employeeGetStartedSteps {
employeeGetStartedSteps {
id
name
order
state
}
}
Response
{
"data": {
"employeeGetStartedSteps": [
{"id": 4, "name": "CLOCK_IN", "order": 987, "state": "FINISHED"}
]
}
}
employeeImportRequest
Description
Get employee import request details
Response
Returns an EmployeeImportRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query employeeImportRequest($id: ID!) {
employeeImportRequest(id: $id) {
createdAt
csvFile
data
id
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
state
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"employeeImportRequest": {
"createdAt": ISO8601DateTime,
"csvFile": "abc123",
"data": {},
"id": 4,
"requester": User,
"state": "DONE",
"updatedAt": ISO8601DateTime
}
}
}
folder
Description
Get folder detail
Example
Query
query folder($id: ID!) {
folder(id: $id) {
createdAt
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
deletedAt
description
documents {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
id
level
name
parent {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
private
subFolders {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"folder": {
"createdAt": ISO8601DateTime,
"creator": User,
"deletedAt": ISO8601DateTime,
"description": "abc123",
"documents": [Document],
"id": "4",
"level": 123,
"name": "xyz789",
"parent": Folder,
"private": false,
"subFolders": [Folder],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
folders
Description
Lists all folders from a workspace
Response
Returns [Folder!]!
Arguments
| Name | Description |
|---|---|
filter - FolderFilter
|
Example
Query
query folders($filter: FolderFilter) {
folders(filter: $filter) {
createdAt
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
deletedAt
description
documents {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
id
level
name
parent {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
private
subFolders {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"filter": FolderFilter}
Response
{
"data": {
"folders": [
{
"createdAt": ISO8601DateTime,
"creator": User,
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"documents": [Document],
"id": "4",
"level": 123,
"name": "xyz789",
"parent": Folder,
"private": false,
"subFolders": [Folder],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
]
}
}
group
Description
Get a group detail
Example
Query
query group($id: ID!) {
group(id: $id) {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
usersCount
}
}
Variables
{"id": 4}
Response
{
"data": {
"group": {
"color": "abc123",
"colorName": "xyz789",
"createdAt": ISO8601DateTime,
"default": false,
"deletedAt": ISO8601DateTime,
"id": "4",
"name": "xyz789",
"updatedAt": ISO8601DateTime,
"users": [User],
"usersCount": 123
}
}
}
groups
Description
Lists all groups from a specific filter
Response
Returns a GroupSearchPayload!
Arguments
| Name | Description |
|---|---|
filter - GroupFilter
|
Example
Query
query groups($filter: GroupFilter) {
groups(filter: $filter) {
seedGroups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
userGroups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
workspaceGroups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
}
}
Variables
{"filter": GroupFilter}
Response
{
"data": {
"groups": {
"seedGroups": [Group],
"userGroups": [Group],
"workspaceGroups": [Group]
}
}
}
jobSites
Description
Lists all job sites of the current workspace
Response
Returns a JobSiteConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - JobSiteFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query jobSites(
$after: String,
$before: String,
$filter: JobSiteFilter,
$first: Int,
$last: Int
) {
jobSites(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...JobSiteFragment
}
}
nodes {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"filter": JobSiteFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"jobSites": {
"edges": [JobSiteEdge],
"nodes": [JobSite],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
joinCode
Description
Returns the workspace effective join_code
Response
Returns a JoinCode
Example
Query
query joinCode {
joinCode {
code
effectiveUntil
id
requireApproval
}
}
Response
{
"data": {
"joinCode": {
"code": "abc123",
"effectiveUntil": ISO8601DateTime,
"id": 4,
"requireApproval": false
}
}
}
joinRequests
Description
Lists all join request from a workspace
Response
Returns a JoinRequestConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - JoinRequestFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query joinRequests(
$after: String,
$before: String,
$filter: JoinRequestFilter,
$first: Int,
$last: Int
) {
joinRequests(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...JoinRequestFragment
}
}
nodes {
id
state
user {
...UserFragment
}
userInfo
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filter": JoinRequestFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"joinRequests": {
"edges": [JoinRequestEdge],
"nodes": [JoinRequest],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
kioskUsers
Description
Lists all users from a workspace if the requester is kiosk app
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query kioskUsers(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
kioskUsers(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
cursor
node {
...UserFragment
}
}
nodes {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"last": 987
}
Response
{
"data": {
"kioskUsers": {
"edges": [UserEdge],
"nodes": [User],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
leaveCategories
Description
All leave categories of current workspace
Response
Returns a LeaveCategoryConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - LeaveCategoryFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query leaveCategories(
$after: String,
$before: String,
$filter: LeaveCategoryFilter,
$first: Int,
$last: Int
) {
leaveCategories(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...LeaveCategoryFragment
}
}
nodes {
enabled
id
name
paidLeave
unpaidLeave
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"filter": LeaveCategoryFilter,
"first": 987,
"last": 123
}
Response
{
"data": {
"leaveCategories": {
"edges": [LeaveCategoryEdge],
"nodes": [LeaveCategory],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
leaveRequest
Description
Get leave detail
Response
Returns a LeaveRequest
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query leaveRequest($id: ID!) {
leaveRequest(id: $id) {
allDay
approvedAt
approver {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
approverId
canceledAt
days {
date
minutes
}
draftAt
employee {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
from
id
leaveCategory {
enabled
id
name
paidLeave
unpaidLeave
workspace {
...WorkspaceFragment
}
}
paid
processedAt
reason
rejectedAt
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"leaveRequest": {
"allDay": true,
"approvedAt": ISO8601DateTime,
"approver": User,
"approverId": 4,
"canceledAt": ISO8601DateTime,
"days": [LeaveRequestDay],
"draftAt": ISO8601DateTime,
"employee": User,
"from": ISO8601DateTime,
"id": 4,
"leaveCategory": LeaveCategory,
"paid": true,
"processedAt": ISO8601DateTime,
"reason": "abc123",
"rejectedAt": ISO8601DateTime,
"requester": User,
"state": "APPROVED",
"submittedAt": ISO8601DateTime,
"timezone": "abc123",
"to": ISO8601DateTime,
"totalDuration": Minute,
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
leaveRequestApprovers
Description
List all users eligible to approve LR of current workspace
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query leaveRequestApprovers(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
leaveRequestApprovers(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
cursor
node {
...UserFragment
}
}
nodes {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"last": 987
}
Response
{
"data": {
"leaveRequestApprovers": {
"edges": [UserEdge],
"nodes": [User],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
leaveRequests
Description
Lists all leaves from a workspace
Response
Returns a LeaveRequestConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - LeaveFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
order - LeaveOrder
|
Default = {column: FROM, direction: DESC} |
Example
Query
query leaveRequests(
$after: String,
$before: String,
$filter: LeaveFilter,
$first: Int,
$last: Int,
$order: LeaveOrder
) {
leaveRequests(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last,
order: $order
) {
edges {
cursor
node {
...LeaveRequestFragment
}
}
nodes {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"filter": LeaveFilter,
"first": 123,
"last": 123,
"order": {"column": "FROM", "direction": "DESC"}
}
Response
{
"data": {
"leaveRequests": {
"edges": [LeaveRequestEdge],
"nodes": [LeaveRequest],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
leaveRequestsReport
Description
Leaves report
Response
Returns a LeaveReportResult!
Arguments
| Name | Description |
|---|---|
filter - LeaveReportFilter
|
Example
Query
query leaveRequestsReport($filter: LeaveReportFilter) {
leaveRequestsReport(filter: $filter) {
paidLeaves
unpaidLeaves
}
}
Variables
{"filter": LeaveReportFilter}
Response
{"data": {"leaveRequestsReport": {"paidLeaves": 123, "unpaidLeaves": 123}}}
messageBoard
Description
Get message board detail
Response
Returns a MessageBoard
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query messageBoard($id: ID!) {
messageBoard(id: $id) {
categories {
createdAt
deletedAt
id
messageBoard {
...MessageBoardFragment
}
name
updatedAt
}
createdAt
deletedAt
description
id
messageBoardsMembers {
createdAt
deletedAt
id
messageBoard {
...MessageBoardFragment
}
role
updatedAt
user {
...UserFragment
}
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"messageBoard": {
"categories": [MessageBoardCategory],
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"id": 4,
"messageBoardsMembers": [MessageBoardsMember],
"name": "abc123",
"pinnedAt": ISO8601DateTime,
"shareWithNewHires": false,
"unreadMessagesCount": 987,
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
messageBoardPost
Description
Get message board post detail
Response
Returns a MessageBoardPost
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query messageBoardPost($id: ID!) {
messageBoardPost(id: $id) {
acknowledgementRequired
acknowledgements {
acknowledgeable {
... on Document {
...DocumentFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
}
acknowledgedAt
createdAt
deletedAt
id
updatedAt
user {
...UserFragment
}
}
archivedAt
author {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
blocks
board {
categories {
...MessageBoardCategoryFragment
}
createdAt
deletedAt
description
id
messageBoardsMembers {
...MessageBoardsMemberFragment
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
...WorkspaceFragment
}
}
category {
createdAt
deletedAt
id
messageBoard {
...MessageBoardFragment
}
name
updatedAt
}
commentEnabled
commentsCount
confirmationRequiredUsers {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
createdAt
deletedAt
draftAt
id
images {
createdAt
id
image
messageBoardPostId
updatedAt
}
messageBoardId
notifyUsers {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
pinnedAt
publishedAt
reactions {
createdAt
creator {
...UserFragment
}
emoji
id
reactable {
... on Comment {
...CommentFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
}
updatedAt
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"messageBoardPost": {
"acknowledgementRequired": true,
"acknowledgements": [Acknowledgement],
"archivedAt": ISO8601DateTime,
"author": User,
"blocks": {},
"board": MessageBoard,
"category": MessageBoardCategory,
"commentEnabled": true,
"commentsCount": 987,
"confirmationRequiredUsers": [User],
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"draftAt": ISO8601DateTime,
"id": "4",
"images": [MessageBoardPostImage],
"messageBoardId": "4",
"notifyUsers": [User],
"pinnedAt": ISO8601DateTime,
"publishedAt": ISO8601DateTime,
"reactions": [Reaction],
"readAt": ISO8601DateTime,
"scheduledPostAt": ISO8601DateTime,
"state": "ARCHIVED",
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
}
}
messageBoardPosts
Description
Lists all message board posts from a workspace
Response
Returns a MessageBoardPostConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - MessageBoardPostFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query messageBoardPosts(
$after: String,
$before: String,
$filter: MessageBoardPostFilter,
$first: Int,
$last: Int
) {
messageBoardPosts(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...MessageBoardPostFragment
}
}
nodes {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"filter": MessageBoardPostFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"messageBoardPosts": {
"edges": [MessageBoardPostEdge],
"nodes": [MessageBoardPost],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
messageBoards
Description
Lists all message boards from a workspace
Response
Returns [MessageBoard!]!
Arguments
| Name | Description |
|---|---|
filter - MessageBoardFilter
|
Example
Query
query messageBoards($filter: MessageBoardFilter) {
messageBoards(filter: $filter) {
categories {
createdAt
deletedAt
id
messageBoard {
...MessageBoardFragment
}
name
updatedAt
}
createdAt
deletedAt
description
id
messageBoardsMembers {
createdAt
deletedAt
id
messageBoard {
...MessageBoardFragment
}
role
updatedAt
user {
...UserFragment
}
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"filter": MessageBoardFilter}
Response
{
"data": {
"messageBoards": [
{
"categories": [MessageBoardCategory],
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"id": 4,
"messageBoardsMembers": [MessageBoardsMember],
"name": "xyz789",
"pinnedAt": ISO8601DateTime,
"shareWithNewHires": true,
"unreadMessagesCount": 987,
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
]
}
}
messageReadReceipts
Description
Lists all users who read a message
Example
Query
query messageReadReceipts($id: ID!) {
messageReadReceipts(id: $id) {
address
avatarUrl
birthday
dataState
email
firstName
groups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
kioskPinCode
lastName
membershipSettings {
emailLeaveRequest
emailManageAvailabilityRequest
emailManageDocument
emailManageLeaveRequest
emailManageMessageBoard
emailManageShiftOfferRequest
emailManageShiftSwapRequest
emailManageTimesheet
emailSchedulePosted
emailShiftOfferRequest
emailShiftReminder
emailShiftSwapRequest
emailSummary
emailTimesheet
id
maxDurationPerWeek
notificationShiftLate
typicalWorkDuration
}
name
phoneNumber
roles
sampleUser
schedules {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
state
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"messageReadReceipts": [
{
"address": "xyz789",
"avatarUrl": "xyz789",
"birthday": ISO8601DateTime,
"dataState": "COMPLETE",
"email": "xyz789",
"firstName": "abc123",
"groups": [Group],
"id": "4",
"kioskPinCode": "abc123",
"lastName": "abc123",
"membershipSettings": MembershipSetting,
"name": "abc123",
"phoneNumber": "xyz789",
"roles": ["CONTRACTOR"],
"sampleUser": false,
"schedules": [Schedule],
"state": "ACTIVE",
"updatedAt": ISO8601DateTime
}
]
}
}
messages
Description
Lists all messages from a channel
Response
Returns a ChatMessageConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
channelId - ID!
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query messages(
$after: String,
$before: String,
$channelId: ID!,
$first: Int,
$last: Int
) {
messages(
after: $after,
before: $before,
channelId: $channelId,
first: $first,
last: $last
) {
edges {
cursor
node {
...ChatMessageFragment
}
}
nodes {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"channelId": 4,
"first": 123,
"last": 987
}
Response
{
"data": {
"messages": {
"edges": [ChatMessageEdge],
"nodes": [ChatMessage],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
notifications
Description
Lists all notifications of a current user of the workspace
Response
Returns a NotificationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - NotificationFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query notifications(
$after: String,
$before: String,
$filter: NotificationFilter,
$first: Int,
$last: Int
) {
notifications(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...NotificationFragment
}
}
nodes {
actedUponAt
createdAt
id
message
notificationType
readAt
recipient {
...UserFragment
}
recipientId
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
sender {
...UserFragment
}
senderId
title
updatedAt
workspaceId
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"filter": NotificationFilter,
"first": 987,
"last": 123
}
Response
{
"data": {
"notifications": {
"edges": [NotificationEdge],
"nodes": [Notification],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
payRun
Description
Get Pay Run detail
payRuns
Description
Lists all payruns from a workspace
Response
Returns a PayRunConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - PayRunFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query payRuns(
$after: String,
$before: String,
$filter: PayRunFilter,
$first: Int,
$last: Int
) {
payRuns(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...PayRunFragment
}
}
nodes {
id
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filter": PayRunFilter,
"first": 123,
"last": 987
}
Response
{
"data": {
"payRuns": {
"edges": [PayRunEdge],
"nodes": [PayRun],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
payslip
Description
Get payslip detail
payslips
Description
Lists all payslips from workspace payruns
Response
Returns a PayslipConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - PayslipFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
order - PayslipOrder
|
Default = {column: EMPLOYEE_NAME, direction: ASC} |
Example
Query
query payslips(
$after: String,
$before: String,
$filter: PayslipFilter,
$first: Int,
$last: Int,
$order: PayslipOrder
) {
payslips(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last,
order: $order
) {
edges {
cursor
node {
...PayslipFragment
}
}
nodes {
id
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filter": PayslipFilter,
"first": 123,
"last": 987,
"order": {"column": "EMPLOYEE_NAME", "direction": "ASC"}
}
Response
{
"data": {
"payslips": {
"edges": [PayslipEdge],
"nodes": [Payslip],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
policyMatrix
Description
Returns the policy matrix for authorization
Response
Returns [PolicyMatrixItem!]!
Example
Query
query policyMatrix {
policyMatrix {
evaluator
id
policy
}
}
Response
{
"data": {
"policyMatrix": [
{
"evaluator": "abc123",
"id": "xyz789",
"policy": "abc123"
}
]
}
}
roles
Description
Lists all roles from a workspace
Response
Returns a RoleConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query roles(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
roles(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
cursor
node {
...RoleFragment
}
}
nodes {
code
description
id
name
rolesUsers {
...RolesUserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 987
}
Response
{
"data": {
"roles": {
"edges": [RoleEdge],
"nodes": [Role],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
schedule
Description
Get schedule detail
Example
Query
query schedule($id: ID!) {
schedule(id: $id) {
color
createdAt
default
defaultJobSite {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
id
name
schedulesUsers {
id
rank
user {
...UserFragment
}
}
timezone
updatedAt
users {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"schedule": {
"color": "abc123",
"createdAt": ISO8601DateTime,
"default": false,
"defaultJobSite": JobSite,
"id": "4",
"name": "abc123",
"schedulesUsers": [ScheduleUser],
"timezone": "xyz789",
"updatedAt": ISO8601DateTime,
"users": [User]
}
}
}
scheduleData
Description
Get shifts, leaves, and availabilities of schedules within a period
Response
Returns a ScheduleData!
Arguments
| Name | Description |
|---|---|
filter - ScheduleDataFilter!
|
Example
Query
query scheduleData($filter: ScheduleDataFilter!) {
scheduleData(filter: $filter) {
availabilities {
allDay
createdAt
from
id
note
recurrence {
...RecurrenceFragment
}
timezone
to
type
updatedAt
user {
...UserFragment
}
}
groups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
jobSites {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
leaveRequests {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
shifts {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"filter": ScheduleDataFilter}
Response
{
"data": {
"scheduleData": {
"availabilities": [Availability],
"groups": [Group],
"jobSites": [JobSite],
"leaveRequests": [LeaveRequest],
"shifts": [Shift]
}
}
}
scheduleIcalUrl
Description
Schedule ical url of current user
schedulePhotos
Description
Lists all schedule photos
Response
Returns a SchedulePhotoConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - SchedulePhotoFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query schedulePhotos(
$after: String,
$before: String,
$filter: SchedulePhotoFilter,
$first: Int,
$last: Int
) {
schedulePhotos(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...SchedulePhotoFragment
}
}
nodes {
from
id
photo
schedule {
...ScheduleFragment
}
timezone
to
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"filter": SchedulePhotoFilter,
"first": 987,
"last": 123
}
Response
{
"data": {
"schedulePhotos": {
"edges": [SchedulePhotoEdge],
"nodes": [SchedulePhoto],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
scheduledActualHoursReport
Description
Get scheduled vs. actual duration per day for each employee
Response
Returns [ScheduledActualResponse!]!
Arguments
| Name | Description |
|---|---|
filter - ScheduledActualReportFilter!
|
Example
Query
query scheduledActualHoursReport($filter: ScheduledActualReportFilter!) {
scheduledActualHoursReport(filter: $filter) {
days {
actual
date
scheduled
}
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"filter": ScheduledActualReportFilter}
Response
{
"data": {
"scheduledActualHoursReport": [
{
"days": [ScheduledActualPerDay],
"user": User
}
]
}
}
scheduledStaffingReport
Description
Get scheduled staffing report
Response
Returns [Shift!]!
Arguments
| Name | Description |
|---|---|
filter - ScheduledStaffingReportFilter!
|
Example
Query
query scheduledStaffingReport($filter: ScheduledStaffingReportFilter!) {
scheduledStaffingReport(filter: $filter) {
approvedTargetedShiftSwapRequests {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftSwap {
...ShiftSwapFragment
}
state
targetShift {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
assignee {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
attachments {
attachment
createdAt
id
jobSiteAttachment {
...JobSiteAttachmentFragment
}
shiftId
updatedAt
}
breakDuration
checklistAssignments {
assignable {
... on Group {
...GroupFragment
}
... on JobSite {
...JobSiteFragment
}
... on Schedule {
...ScheduleFragment
}
... on Shift {
...ShiftFragment
}
}
checklist {
...ChecklistFragment
}
collaborationMode
completionPercentage
date
id
recurrence {
...RecurrenceFragment
}
}
client {
clientNumber
createdAt
email
id
name
phoneNumber
updatedAt
}
color
endTime
endType
group {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
jobSite {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
note
recurrence {
id
rrule
timezone
}
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
requireClaimApproval
schedule {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
shiftBatchId
shiftClaimRequests {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
state
}
shiftPartners {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
shiftRequests {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftOfferRequests {
...ShiftOfferRequestFragment
}
shiftSwapRequests {
...ShiftSwapRequestFragment
}
state
type
workspace {
...WorkspaceFragment
}
}
startTime
state
systemNote
timeCard {
autoDeductedUnpaidBreakDuration
createdAt
creator {
...UserFragment
}
endTime
group {
...GroupFragment
}
hasWarning
id
note
punches {
...TimeCardPunchFragment
}
schedule {
...ScheduleFragment
}
shift {
...ShiftFragment
}
shiftId
startTime
state
timezone
totalDuration
}
timezone
title
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"filter": ScheduledStaffingReportFilter}
Response
{
"data": {
"scheduledStaffingReport": [
{
"approvedTargetedShiftSwapRequests": [
ShiftSwapRequest
],
"assignee": User,
"attachments": [ShiftAttachment],
"breakDuration": Minute,
"checklistAssignments": [ChecklistAssignment],
"client": Client,
"color": "abc123",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"group": Group,
"id": 4,
"jobSite": JobSite,
"note": "xyz789",
"recurrence": Recurrence,
"requester": User,
"requireClaimApproval": false,
"schedule": Schedule,
"shiftBatchId": "4",
"shiftClaimRequests": [ShiftClaimRequest],
"shiftPartners": [Shift],
"shiftRequests": [ShiftRequest],
"startTime": ISO8601DateTime,
"state": "ABSENT",
"systemNote": "xyz789",
"timeCard": TimeCard,
"timezone": "abc123",
"title": "xyz789",
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
]
}
}
schedules
Description
Lists all schedules the current user can view
Response
Returns a ScheduleConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - ScheduleFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query schedules(
$after: String,
$before: String,
$filter: ScheduleFilter,
$first: Int,
$last: Int
) {
schedules(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...ScheduleFragment
}
}
nodes {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"filter": ScheduleFilter,
"first": 123,
"last": 123
}
Response
{
"data": {
"schedules": {
"edges": [ScheduleEdge],
"nodes": [Schedule],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
shift
Description
Get shift detail
Example
Query
query shift($id: ID!) {
shift(id: $id) {
approvedTargetedShiftSwapRequests {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftSwap {
...ShiftSwapFragment
}
state
targetShift {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
assignee {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
attachments {
attachment
createdAt
id
jobSiteAttachment {
...JobSiteAttachmentFragment
}
shiftId
updatedAt
}
breakDuration
checklistAssignments {
assignable {
... on Group {
...GroupFragment
}
... on JobSite {
...JobSiteFragment
}
... on Schedule {
...ScheduleFragment
}
... on Shift {
...ShiftFragment
}
}
checklist {
...ChecklistFragment
}
collaborationMode
completionPercentage
date
id
recurrence {
...RecurrenceFragment
}
}
client {
clientNumber
createdAt
email
id
name
phoneNumber
updatedAt
}
color
endTime
endType
group {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
jobSite {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
note
recurrence {
id
rrule
timezone
}
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
requireClaimApproval
schedule {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
shiftBatchId
shiftClaimRequests {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
state
}
shiftPartners {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
shiftRequests {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftOfferRequests {
...ShiftOfferRequestFragment
}
shiftSwapRequests {
...ShiftSwapRequestFragment
}
state
type
workspace {
...WorkspaceFragment
}
}
startTime
state
systemNote
timeCard {
autoDeductedUnpaidBreakDuration
createdAt
creator {
...UserFragment
}
endTime
group {
...GroupFragment
}
hasWarning
id
note
punches {
...TimeCardPunchFragment
}
schedule {
...ScheduleFragment
}
shift {
...ShiftFragment
}
shiftId
startTime
state
timezone
totalDuration
}
timezone
title
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"shift": {
"approvedTargetedShiftSwapRequests": [
ShiftSwapRequest
],
"assignee": User,
"attachments": [ShiftAttachment],
"breakDuration": Minute,
"checklistAssignments": [ChecklistAssignment],
"client": Client,
"color": "xyz789",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"group": Group,
"id": 4,
"jobSite": JobSite,
"note": "abc123",
"recurrence": Recurrence,
"requester": User,
"requireClaimApproval": false,
"schedule": Schedule,
"shiftBatchId": 4,
"shiftClaimRequests": [ShiftClaimRequest],
"shiftPartners": [Shift],
"shiftRequests": [ShiftRequest],
"startTime": ISO8601DateTime,
"state": "ABSENT",
"systemNote": "xyz789",
"timeCard": TimeCard,
"timezone": "xyz789",
"title": "abc123",
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
shiftClaimRequests
Description
Lists all shift claim requests from a workspace
Response
Returns a ShiftClaimRequestConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - ShiftClaimRequestFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query shiftClaimRequests(
$after: String,
$before: String,
$filter: ShiftClaimRequestFilter,
$first: Int,
$last: Int
) {
shiftClaimRequests(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...ShiftClaimRequestFragment
}
}
nodes {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
state
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"filter": ShiftClaimRequestFilter,
"first": 123,
"last": 123
}
Response
{
"data": {
"shiftClaimRequests": {
"edges": [ShiftClaimRequestEdge],
"nodes": [ShiftClaimRequest],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
shiftOffer
Description
Get shift offer detail
Response
Returns a ShiftOffer
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query shiftOffer($id: ID!) {
shiftOffer(id: $id) {
createdAt
id
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
shift {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
shiftOfferRequests {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftOffer {
...ShiftOfferFragment
}
state
workspace {
...WorkspaceFragment
}
}
state
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"shiftOffer": {
"createdAt": ISO8601DateTime,
"id": 4,
"requester": User,
"shift": Shift,
"shiftOfferRequests": [ShiftOfferRequest],
"state": "ACCEPTED",
"workspace": Workspace
}
}
}
shiftRequests
Description
Lists all shift requests from a workspace
Response
Returns a ShiftRequestConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - ShiftRequestFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query shiftRequests(
$after: String,
$before: String,
$filter: ShiftRequestFilter,
$first: Int,
$last: Int
) {
shiftRequests(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...ShiftRequestFragment
}
}
nodes {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftOfferRequests {
...ShiftOfferRequestFragment
}
shiftSwapRequests {
...ShiftSwapRequestFragment
}
state
type
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filter": ShiftRequestFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"shiftRequests": {
"edges": [ShiftRequestEdge],
"nodes": [ShiftRequest],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
shiftSwap
Description
Get shift swap detail
Example
Query
query shiftSwap($id: ID!) {
shiftSwap(id: $id) {
createdAt
id
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
shift {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
shiftSwapRequests {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftSwap {
...ShiftSwapFragment
}
state
targetShift {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
state
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"shiftSwap": {
"createdAt": ISO8601DateTime,
"id": 4,
"requester": User,
"shift": Shift,
"shiftSwapRequests": [ShiftSwapRequest],
"state": "ACCEPTED",
"workspace": Workspace
}
}
}
shiftTemplates
Description
Return most relevant shift templates (30 at maxium) based on criterias
Response
Returns [ShiftTemplate!]!
Arguments
| Name | Description |
|---|---|
filter - ShiftTemplateFilter
|
Example
Query
query shiftTemplates($filter: ShiftTemplateFilter) {
shiftTemplates(filter: $filter) {
breakDuration
endTime
endType
group {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
jobSite {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
name
note
schedule {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
startTime
timezone
}
}
Variables
{"filter": ShiftTemplateFilter}
Response
{
"data": {
"shiftTemplates": [
{
"breakDuration": Minute,
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"group": Group,
"id": 4,
"jobSite": JobSite,
"name": "xyz789",
"note": "xyz789",
"schedule": Schedule,
"startTime": ISO8601DateTime,
"timezone": "abc123"
}
]
}
}
shifts
Description
Lists all shifts from a workspace
Response
Returns a ShiftConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - ShiftFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query shifts(
$after: String,
$before: String,
$filter: ShiftFilter,
$first: Int,
$last: Int
) {
shifts(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...ShiftFragment
}
}
nodes {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"filter": ShiftFilter,
"first": 123,
"last": 987
}
Response
{
"data": {
"shifts": {
"edges": [ShiftEdge],
"nodes": [Shift],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
task
Description
Get task detail
Example
Query
query task($id: ID!) {
task(id: $id) {
assignee {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
checklist {
creator {
...UserFragment
}
id
name
tasks {
...TaskFragment
}
template
workspace {
...WorkspaceFragment
}
}
code
comments {
author {
...UserFragment
}
commentableId
commentableType
content
createdAt
data {
...CommentDataEntryFragment
}
id
pinnedAt
reactions {
...ReactionFragment
}
systemGenerated
visibility
}
completedLog {
at
by {
...UserFragment
}
type
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
requester {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
state
subTasks {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"task": {
"assignee": User,
"checklist": Checklist,
"code": "abc123",
"comments": [Comment],
"completedLog": [CompletedLog],
"completionCountTarget": 123,
"description": "abc123",
"doneAt": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"id": 4,
"inProgressAt": ISO8601DateTime,
"lastCompletedAt": ISO8601DateTime,
"name": "abc123",
"notStartedAt": ISO8601DateTime,
"parent": Task,
"requester": User,
"state": "DONE",
"subTasks": [Task],
"workspace": Workspace
}
}
}
tasks
Description
Lists all tasks from a workspace
Response
Returns a TaskConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - TaskFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query tasks(
$after: String,
$before: String,
$filter: TaskFilter,
$first: Int,
$last: Int
) {
tasks(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...TaskFragment
}
}
nodes {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"filter": TaskFilter,
"first": 987,
"last": 987
}
Response
{
"data": {
"tasks": {
"edges": [TaskEdge],
"nodes": [Task],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
thisWeekSnapshot
Description
A snapshot of this week schedule
Response
Returns a ThisWeekSnapshot!
Arguments
| Name | Description |
|---|---|
filter - ThisWeekSnapshotFilter
|
Example
Query
query thisWeekSnapshot($filter: ThisWeekSnapshotFilter) {
thisWeekSnapshot(filter: $filter) {
assignedShifts
id
openShifts
pendingTimesheets
scheduledShifts
unfinishedShifts
}
}
Variables
{"filter": ThisWeekSnapshotFilter}
Response
{
"data": {
"thisWeekSnapshot": {
"assignedShifts": 987,
"id": 4,
"openShifts": 987,
"pendingTimesheets": 123,
"scheduledShifts": 123,
"unfinishedShifts": 123
}
}
}
timeCard
Description
Get timeCard detail
Example
Query
query timeCard($id: ID!) {
timeCard(id: $id) {
autoDeductedUnpaidBreakDuration
createdAt
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
endTime
group {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
hasWarning
id
note
punches {
atTime
attachment {
...TimeCardPunchAttachmentFragment
}
createdAt
id
note
punchType
timeCardId
updatedAt
warnings {
...TimeCardPunchWarningFragment
}
}
schedule {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
shift {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
shiftId
startTime
state
timezone
totalDuration
}
}
Variables
{"id": 4}
Response
{
"data": {
"timeCard": {
"autoDeductedUnpaidBreakDuration": Minute,
"createdAt": ISO8601DateTime,
"creator": User,
"endTime": ISO8601DateTime,
"group": Group,
"hasWarning": true,
"id": 4,
"note": "xyz789",
"punches": [TimeCardPunch],
"schedule": Schedule,
"shift": Shift,
"shiftId": "4",
"startTime": ISO8601DateTime,
"state": "CLOCKED_IN",
"timezone": "xyz789",
"totalDuration": Minute
}
}
}
timeCardArrivalStatusReport
Description
Get attendance on-time summary
Response
Returns an ArrivalStatusResponse!
Arguments
| Name | Description |
|---|---|
filter - ArrivalStatusReportFilter!
|
Example
Query
query timeCardArrivalStatusReport($filter: ArrivalStatusReportFilter!) {
timeCardArrivalStatusReport(filter: $filter) {
early
late
mostOnTimeUsers {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
ontime
unscheduled
}
}
Variables
{"filter": ArrivalStatusReportFilter}
Response
{
"data": {
"timeCardArrivalStatusReport": {
"early": 123.45,
"late": 123.45,
"mostOnTimeUsers": [User],
"ontime": 123.45,
"unscheduled": 987.65
}
}
}
timeCards
Description
Lists all timecard from a workspace
Response
Returns a TimeCardConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - TimeCardFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query timeCards(
$after: String,
$before: String,
$filter: TimeCardFilter,
$first: Int,
$last: Int
) {
timeCards(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last
) {
edges {
cursor
node {
...TimeCardFragment
}
}
nodes {
autoDeductedUnpaidBreakDuration
createdAt
creator {
...UserFragment
}
endTime
group {
...GroupFragment
}
hasWarning
id
note
punches {
...TimeCardPunchFragment
}
schedule {
...ScheduleFragment
}
shift {
...ShiftFragment
}
shiftId
startTime
state
timezone
totalDuration
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"filter": TimeCardFilter,
"first": 123,
"last": 123
}
Response
{
"data": {
"timeCards": {
"edges": [TimeCardEdge],
"nodes": [TimeCard],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
timesheet
Description
Get a timesheet detail
Example
Query
query timesheet($id: ID!) {
timesheet(id: $id) {
approvedAt
approver {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
comments
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
draftAt
employee {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
from
group {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"timesheet": {
"approvedAt": ISO8601DateTime,
"approver": User,
"comments": 123,
"creator": User,
"draftAt": ISO8601DateTime,
"employee": User,
"from": ISO8601DateTime,
"group": Group,
"id": 4,
"processedAt": ISO8601DateTime,
"referenceObject": Document,
"rejectedAt": ISO8601DateTime,
"schedule": Schedule,
"state": "APPROVED",
"submittedAt": ISO8601DateTime,
"timezone": "abc123",
"to": ISO8601DateTime,
"totalDuration": Minute,
"unpaidBreaks": [TimesheetAutoDeductBreak],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
timesheetByReferenceObject
Description
Get a timesheet detail by reference object
Response
Returns a Timesheet
Arguments
| Name | Description |
|---|---|
referenceObjectId - ID!
|
|
referenceObjectType - ReferenceObjectTypeEnum!
|
Example
Query
query timesheetByReferenceObject(
$referenceObjectId: ID!,
$referenceObjectType: ReferenceObjectTypeEnum!
) {
timesheetByReferenceObject(
referenceObjectId: $referenceObjectId,
referenceObjectType: $referenceObjectType
) {
approvedAt
approver {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
comments
creator {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
draftAt
employee {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
from
group {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{
"referenceObjectId": "4",
"referenceObjectType": "LEAVE_REQUEST"
}
Response
{
"data": {
"timesheetByReferenceObject": {
"approvedAt": ISO8601DateTime,
"approver": User,
"comments": 123,
"creator": User,
"draftAt": ISO8601DateTime,
"employee": User,
"from": ISO8601DateTime,
"group": Group,
"id": 4,
"processedAt": ISO8601DateTime,
"referenceObject": Document,
"rejectedAt": ISO8601DateTime,
"schedule": Schedule,
"state": "APPROVED",
"submittedAt": ISO8601DateTime,
"timezone": "abc123",
"to": ISO8601DateTime,
"totalDuration": Minute,
"unpaidBreaks": [TimesheetAutoDeductBreak],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
}
}
timesheets
Description
Lists all timesheets from a workspace
Response
Returns a TimesheetConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - TimesheetFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
order - TimesheetOrder
|
Default = {column: FROM, direction: DESC} |
Example
Query
query timesheets(
$after: String,
$before: String,
$filter: TimesheetFilter,
$first: Int,
$last: Int,
$order: TimesheetOrder
) {
timesheets(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last,
order: $order
) {
edges {
cursor
node {
...TimesheetFragment
}
}
nodes {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"filter": TimesheetFilter,
"first": 123,
"last": 987,
"order": {"column": "FROM", "direction": "DESC"}
}
Response
{
"data": {
"timesheets": {
"edges": [TimesheetEdge],
"nodes": [Timesheet],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
timesheetsReport
Description
Get employee's hours worked
Response
Returns a TimesheetReportResult!
Arguments
| Name | Description |
|---|---|
filter - TimesheetReportFilter
|
Example
Query
query timesheetsReport($filter: TimesheetReportFilter) {
timesheetsReport(filter: $filter) {
workingHoursApproved
workingHoursSubmitted
}
}
Variables
{"filter": TimesheetReportFilter}
Response
{
"data": {
"timesheetsReport": {
"workingHoursApproved": Minute,
"workingHoursSubmitted": Minute
}
}
}
timesheetsSummary
Description
Get summary for a given user timesheets
Response
Returns a TimesheetSummaryResponse!
Arguments
| Name | Description |
|---|---|
filter - TimesheetSummaryFilter
|
|
userId - ID!
|
Example
Query
query timesheetsSummary(
$filter: TimesheetSummaryFilter,
$userId: ID!
) {
timesheetsSummary(
filter: $filter,
userId: $userId
) {
doubleOvertime
overtime
regular
timeOff
total
totalApproved
totalScheduled
user {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{
"filter": TimesheetSummaryFilter,
"userId": "4"
}
Response
{
"data": {
"timesheetsSummary": {
"doubleOvertime": Minute,
"overtime": Minute,
"regular": Minute,
"timeOff": Minute,
"total": Minute,
"totalApproved": Minute,
"totalScheduled": Minute,
"user": User
}
}
}
todaySnapshot
Description
A snapshot of today schedule
Response
Returns a TodaySnapshot!
Arguments
| Name | Description |
|---|---|
filter - TodaySnapshotFilter
|
Example
Query
query todaySnapshot($filter: TodaySnapshotFilter) {
todaySnapshot(filter: $filter) {
checklistAssignments {
done
total
}
currentlyClockedIn
currentlyLate
currentlyOnBreak
id
timeOffs
}
}
Variables
{"filter": TodaySnapshotFilter}
Response
{
"data": {
"todaySnapshot": {
"checklistAssignments": TodaySnapshotChecklistAssignment,
"currentlyClockedIn": 123,
"currentlyLate": 123,
"currentlyOnBreak": 123,
"id": 4,
"timeOffs": 123
}
}
}
unreadNotificationsCount
Description
Return the count of unread notifications
Response
Returns an Int!
Example
Query
query unreadNotificationsCount {
unreadNotificationsCount
}
Response
{"data": {"unreadNotificationsCount": 123}}
user
Description
Get the user profile detail
Example
Query
query user($id: ID!) {
user(id: $id) {
address
avatarUrl
birthday
dataState
email
firstName
groups {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
id
kioskPinCode
lastName
membershipSettings {
emailLeaveRequest
emailManageAvailabilityRequest
emailManageDocument
emailManageLeaveRequest
emailManageMessageBoard
emailManageShiftOfferRequest
emailManageShiftSwapRequest
emailManageTimesheet
emailSchedulePosted
emailShiftOfferRequest
emailShiftReminder
emailShiftSwapRequest
emailSummary
emailTimesheet
id
maxDurationPerWeek
notificationShiftLate
typicalWorkDuration
}
name
phoneNumber
roles
sampleUser
schedules {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
state
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"user": {
"address": "abc123",
"avatarUrl": "abc123",
"birthday": ISO8601DateTime,
"dataState": "COMPLETE",
"email": "xyz789",
"firstName": "abc123",
"groups": [Group],
"id": 4,
"kioskPinCode": "xyz789",
"lastName": "abc123",
"membershipSettings": MembershipSetting,
"name": "xyz789",
"phoneNumber": "xyz789",
"roles": ["CONTRACTOR"],
"sampleUser": false,
"schedules": [Schedule],
"state": "ACTIVE",
"updatedAt": ISO8601DateTime
}
}
}
users
Description
Lists all users from a workspace
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
filter - UserFilter
|
|
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
order - UserOrder
|
Example
Query
query users(
$after: String,
$before: String,
$filter: UserFilter,
$first: Int,
$last: Int,
$order: UserOrder
) {
users(
after: $after,
before: $before,
filter: $filter,
first: $first,
last: $last,
order: $order
) {
edges {
cursor
node {
...UserFragment
}
}
nodes {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"filter": UserFilter,
"first": 987,
"last": 987,
"order": UserOrder
}
Response
{
"data": {
"users": {
"edges": [UserEdge],
"nodes": [User],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
whoami
Description
Current user
Response
Returns a Whoami
Example
Query
query whoami {
whoami {
address
avatarUrl
birthday
createdAt
email
firstName
id
kioskPinCode
language
lastName
membershipSettings {
emailLeaveRequest
emailManageAvailabilityRequest
emailManageDocument
emailManageLeaveRequest
emailManageMessageBoard
emailManageShiftOfferRequest
emailManageShiftSwapRequest
emailManageTimesheet
emailSchedulePosted
emailShiftOfferRequest
emailShiftReminder
emailShiftSwapRequest
emailSummary
emailTimesheet
id
maxDurationPerWeek
notificationShiftLate
typicalWorkDuration
}
name
phoneNumber
roles {
code
description
id
name
rolesUsers {
...RolesUserFragment
}
}
settings {
_24HourTime
personalizedData {
...UserPersonalizedDataItemFragment
}
}
timezone
}
}
Response
{
"data": {
"whoami": {
"address": "abc123",
"avatarUrl": "xyz789",
"birthday": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"kioskPinCode": "abc123",
"language": "abc123",
"lastName": "abc123",
"membershipSettings": MembershipSetting,
"name": "abc123",
"phoneNumber": "xyz789",
"roles": [Role],
"settings": UserSetting,
"timezone": "xyz789"
}
}
}
workspace
Description
Current workspace
Response
Returns a Workspace
Example
Query
query workspace {
workspace {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
createdAt
id
type
updatedAt
usageCount
}
name
settings {
_24HourTime
autoApproveTimeoffRequest
autoClockOutAfterShiftEndTimeDuration
autoDeductUnpaidBreaks
birthdayReminder
disabledFeatures
employeeAvailability
facialClockIn
hadDemo
hasSampleData
kioskAttendance
locationClockIn
locationClockInPreventIfExceeded
locationClockInRadius
missedClockEventsEmployeeNotiDelay
missedClockEventsManagerNotiDelay
mobileAttendance
preventFinishShiftsWhenHavingUncompletedTasks
privateScheduling
publicApprovedTimeoffRequest
shiftClockInEarlyThreshold
shiftClockOutEarlyThreshold
shiftEndTimeOffset
shiftStartTimeOffset
timesheetAutoRound
timesheetRoundBreakIncrement
timesheetRoundBreakToScheduledBreakIfShorter
timesheetRoundBreakType
timesheetRoundEndTimeIncrement
timesheetRoundEndTimeToScheduledTimeIfAfter
timesheetRoundEndTimeToScheduledTimeIfEarlier
timesheetRoundEndTimeType
timesheetRoundStartTimeIncrement
timesheetRoundStartTimeToScheduledTimeIfEarlier
timesheetRoundStartTimeType
typicalWorkDuration
unscheduledShifts
weekStartsOn
wifiClockIn
workAniversaryReminder
}
size
timezone
}
}
Response
{
"data": {
"workspace": {
"createdAt": ISO8601DateTime,
"id": "4",
"industry": "CLEANING",
"logoUrl": "xyz789",
"metadata": {},
"meteredUsages": [MeteredUsage],
"name": "abc123",
"settings": WorkspaceSetting,
"size": "LESS_THAN_TEN",
"timezone": "xyz789"
}
}
}
workspaceGetStartedSteps
Description
Lists all get started steps of the current workspace
Response
Returns [WorkspaceGetStartedStep!]!
Example
Query
query workspaceGetStartedSteps {
workspaceGetStartedSteps {
id
name
order
state
}
}
Response
{
"data": {
"workspaceGetStartedSteps": [
{
"id": "4",
"name": "ADD_YOUR_TEAM",
"order": 123,
"state": "FINISHED"
}
]
}
}
workspaces
Description
All workspaces of current user
Response
Returns a WorkspaceConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query workspaces(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
workspaces(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
cursor
node {
...WorkspaceFragment
}
}
nodes {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"workspaces": {
"edges": [WorkspaceEdge],
"nodes": [Workspace],
"pageInfo": PageInfo,
"totalCount": 123
}
}
}
Mutations
acceptShiftOfferRequest
Response
Returns an AcceptShiftOfferRequestPayload
Arguments
| Name | Description |
|---|---|
input - AcceptShiftOfferRequestInput!
|
Parameters for AcceptShiftOfferRequest |
Example
Query
mutation acceptShiftOfferRequest($input: AcceptShiftOfferRequestInput!) {
acceptShiftOfferRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftOffer {
...ShiftOfferFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": AcceptShiftOfferRequestInput}
Response
{
"data": {
"acceptShiftOfferRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftOfferRequest
}
}
}
acceptShiftSwapRequest
Response
Returns an AcceptShiftSwapRequestPayload
Arguments
| Name | Description |
|---|---|
input - AcceptShiftSwapRequestInput!
|
Parameters for AcceptShiftSwapRequest |
Example
Query
mutation acceptShiftSwapRequest($input: AcceptShiftSwapRequestInput!) {
acceptShiftSwapRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftSwap {
...ShiftSwapFragment
}
state
targetShift {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": AcceptShiftSwapRequestInput}
Response
{
"data": {
"acceptShiftSwapRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftSwapRequest
}
}
}
acknowledgeDocument
Response
Returns an AcknowledgeDocumentPayload
Arguments
| Name | Description |
|---|---|
input - AcknowledgeDocumentInput!
|
Parameters for AcknowledgeDocument |
Example
Query
mutation acknowledgeDocument($input: AcknowledgeDocumentInput!) {
acknowledgeDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": AcknowledgeDocumentInput}
Response
{
"data": {
"acknowledgeDocument": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
}
}
answerSurvey
Response
Returns an AnswerSurveyPayload
Arguments
| Name | Description |
|---|---|
input - AnswerSurveyInput!
|
Parameters for AnswerSurvey |
Example
Query
mutation answerSurvey($input: AnswerSurveyInput!) {
answerSurvey(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": AnswerSurveyInput}
Response
{
"data": {
"answerSurvey": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
}
}
approveJoinRequest
Response
Returns an ApproveJoinRequestPayload
Arguments
| Name | Description |
|---|---|
input - ApproveJoinRequestInput!
|
Parameters for ApproveJoinRequest |
Example
Query
mutation approveJoinRequest($input: ApproveJoinRequestInput!) {
approveJoinRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
state
user {
...UserFragment
}
userInfo
}
}
}
Variables
{"input": ApproveJoinRequestInput}
Response
{
"data": {
"approveJoinRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JoinRequest
}
}
}
approveLeaves
Response
Returns an ApproveLeavesPayload
Arguments
| Name | Description |
|---|---|
input - ApproveLeavesInput!
|
Parameters for ApproveLeaves |
Example
Query
mutation approveLeaves($input: ApproveLeavesInput!) {
approveLeaves(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ApproveLeavesInput}
Response
{
"data": {
"approveLeaves": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [LeaveRequest]
}
}
}
approveShiftClaimRequest
Response
Returns an ApproveShiftClaimRequestPayload
Arguments
| Name | Description |
|---|---|
input - ApproveShiftClaimRequestInput!
|
Parameters for ApproveShiftClaimRequest |
Example
Query
mutation approveShiftClaimRequest($input: ApproveShiftClaimRequestInput!) {
approveShiftClaimRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
state
}
}
}
Variables
{"input": ApproveShiftClaimRequestInput}
Response
{
"data": {
"approveShiftClaimRequest": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftClaimRequest
}
}
}
approveShiftOfferRequest
Response
Returns an ApproveShiftOfferRequestPayload
Arguments
| Name | Description |
|---|---|
input - ApproveShiftOfferRequestInput!
|
Parameters for ApproveShiftOfferRequest |
Example
Query
mutation approveShiftOfferRequest($input: ApproveShiftOfferRequestInput!) {
approveShiftOfferRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftOffer {
...ShiftOfferFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ApproveShiftOfferRequestInput}
Response
{
"data": {
"approveShiftOfferRequest": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftOfferRequest
}
}
}
approveShiftSwapRequest
Response
Returns an ApproveShiftSwapRequestPayload
Arguments
| Name | Description |
|---|---|
input - ApproveShiftSwapRequestInput!
|
Parameters for ApproveShiftSwapRequest |
Example
Query
mutation approveShiftSwapRequest($input: ApproveShiftSwapRequestInput!) {
approveShiftSwapRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftSwap {
...ShiftSwapFragment
}
state
targetShift {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ApproveShiftSwapRequestInput}
Response
{
"data": {
"approveShiftSwapRequest": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftSwapRequest
}
}
}
approveTimesheets
Response
Returns an ApproveTimesheetsPayload
Arguments
| Name | Description |
|---|---|
input - ApproveTimesheetsInput!
|
Parameters for ApproveTimesheets |
Example
Query
mutation approveTimesheets($input: ApproveTimesheetsInput!) {
approveTimesheets(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ApproveTimesheetsInput}
Response
{
"data": {
"approveTimesheets": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Timesheet]
}
}
}
archiveChannel
Response
Returns an ArchiveChannelPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveChannelInput!
|
Parameters for ArchiveChannel |
Example
Query
mutation archiveChannel($input: ArchiveChannelInput!) {
archiveChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ArchiveChannelInput}
Response
{
"data": {
"archiveChannel": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatChannel
}
}
}
archiveDocument
Response
Returns an ArchiveDocumentPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveDocumentInput!
|
Parameters for ArchiveDocument |
Example
Query
mutation archiveDocument($input: ArchiveDocumentInput!) {
archiveDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ArchiveDocumentInput}
Response
{
"data": {
"archiveDocument": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
}
}
archiveMember
Response
Returns an ArchiveMemberPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveMemberInput!
|
Parameters for ArchiveMember |
Example
Query
mutation archiveMember($input: ArchiveMemberInput!) {
archiveMember(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": ArchiveMemberInput}
Response
{
"data": {
"archiveMember": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": "xyz789"
}
}
}
bulkRejectTimesheets
Response
Returns a BulkRejectTimesheetsPayload
Arguments
| Name | Description |
|---|---|
input - BulkRejectTimesheetsInput!
|
Parameters for BulkRejectTimesheets |
Example
Query
mutation bulkRejectTimesheets($input: BulkRejectTimesheetsInput!) {
bulkRejectTimesheets(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": BulkRejectTimesheetsInput}
Response
{
"data": {
"bulkRejectTimesheets": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Timesheet]
}
}
}
cancelLeave
Response
Returns a CancelLeavePayload
Arguments
| Name | Description |
|---|---|
input - CancelLeaveInput!
|
Parameters for CancelLeave |
Example
Query
mutation cancelLeave($input: CancelLeaveInput!) {
cancelLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CancelLeaveInput}
Response
{
"data": {
"cancelLeave": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
cancelShiftClaimRequest
Response
Returns a CancelShiftClaimRequestPayload
Arguments
| Name | Description |
|---|---|
input - CancelShiftClaimRequestInput!
|
Parameters for CancelShiftClaimRequest |
Example
Query
mutation cancelShiftClaimRequest($input: CancelShiftClaimRequestInput!) {
cancelShiftClaimRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
state
}
}
}
Variables
{"input": CancelShiftClaimRequestInput}
Response
{
"data": {
"cancelShiftClaimRequest": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftClaimRequest
}
}
}
cancelShiftOffer
Response
Returns a CancelShiftOfferPayload
Arguments
| Name | Description |
|---|---|
input - CancelShiftOfferInput!
|
Parameters for CancelShiftOffer |
Example
Query
mutation cancelShiftOffer($input: CancelShiftOfferInput!) {
cancelShiftOffer(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftOfferRequests {
...ShiftOfferRequestFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CancelShiftOfferInput}
Response
{
"data": {
"cancelShiftOffer": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftOffer
}
}
}
cancelShiftSwap
Response
Returns a CancelShiftSwapPayload
Arguments
| Name | Description |
|---|---|
input - CancelShiftSwapInput!
|
Parameters for CancelShiftSwap |
Example
Query
mutation cancelShiftSwap($input: CancelShiftSwapInput!) {
cancelShiftSwap(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftSwapRequests {
...ShiftSwapRequestFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CancelShiftSwapInput}
Response
{
"data": {
"cancelShiftSwap": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftSwap
}
}
}
claimShift
Response
Returns a ClaimShiftPayload
Arguments
| Name | Description |
|---|---|
input - ClaimShiftInput!
|
Parameters for ClaimShift |
Example
Query
mutation claimShift($input: ClaimShiftInput!) {
claimShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ClaimShiftInput}
Response
{
"data": {
"claimShift": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
}
}
confirmMessageBoardPost
Response
Returns a ConfirmMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - ConfirmMessageBoardPostInput!
|
Parameters for ConfirmMessageBoardPost |
Example
Query
mutation confirmMessageBoardPost($input: ConfirmMessageBoardPostInput!) {
confirmMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": ConfirmMessageBoardPostInput}
Response
{
"data": {
"confirmMessageBoardPost": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
confirmShift
Response
Returns a ConfirmShiftPayload
Arguments
| Name | Description |
|---|---|
input - ConfirmShiftInput!
|
Parameters for ConfirmShift |
Example
Query
mutation confirmShift($input: ConfirmShiftInput!) {
confirmShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ConfirmShiftInput}
Response
{
"data": {
"confirmShift": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
}
}
confirmShifts
Response
Returns a ConfirmShiftsPayload
Arguments
| Name | Description |
|---|---|
input - ConfirmShiftsInput!
|
Parameters for ConfirmShifts |
Example
Query
mutation confirmShifts($input: ConfirmShiftsInput!) {
confirmShifts(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ConfirmShiftsInput}
Response
{
"data": {
"confirmShifts": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Shift]
}
}
}
copyShifts
Description
Copy shifts from the prev week
Response
Returns a CopyShiftsPayload
Arguments
| Name | Description |
|---|---|
input - CopyShiftsInput!
|
Parameters for CopyShifts |
Example
Query
mutation copyShifts($input: CopyShiftsInput!) {
copyShifts(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": CopyShiftsInput}
Response
{
"data": {
"copyShifts": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
}
}
createAvailability
Response
Returns a CreateAvailabilityPayload
Arguments
| Name | Description |
|---|---|
input - CreateAvailabilityInput!
|
Parameters for CreateAvailability |
Example
Query
mutation createAvailability($input: CreateAvailabilityInput!) {
createAvailability(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
from
id
note
recurrence {
...RecurrenceFragment
}
timezone
to
type
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": CreateAvailabilityInput}
Response
{
"data": {
"createAvailability": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Availability
}
}
}
createCalendarEvent
Response
Returns a CreateCalendarEventPayload
Arguments
| Name | Description |
|---|---|
input - CreateCalendarEventInput!
|
Parameters for CreateCalendarEvent |
Example
Query
mutation createCalendarEvent($input: CreateCalendarEventInput!) {
createCalendarEvent(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
creator {
...UserFragment
}
eventType
from
id
note
recurrence {
...RecurrenceFragment
}
schedules {
...ScheduleFragment
}
state
timezone
to
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateCalendarEventInput}
Response
{
"data": {
"createCalendarEvent": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": CalendarEvent
}
}
}
createCalendarEvents
Response
Returns a CreateCalendarEventsPayload
Arguments
| Name | Description |
|---|---|
input - CreateCalendarEventsInput!
|
Parameters for CreateCalendarEvents |
Example
Query
mutation createCalendarEvents($input: CreateCalendarEventsInput!) {
createCalendarEvents(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
creator {
...UserFragment
}
eventType
from
id
note
recurrence {
...RecurrenceFragment
}
schedules {
...ScheduleFragment
}
state
timezone
to
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateCalendarEventsInput}
Response
{
"data": {
"createCalendarEvents": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [CalendarEvent]
}
}
}
createChannel
Response
Returns a CreateChannelPayload
Arguments
| Name | Description |
|---|---|
input - CreateChannelInput!
|
Parameters for CreateChannel |
Example
Query
mutation createChannel($input: CreateChannelInput!) {
createChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateChannelInput}
Response
{
"data": {
"createChannel": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatChannel
}
}
}
createChecklist
Response
Returns a CreateChecklistPayload
Arguments
| Name | Description |
|---|---|
input - CreateChecklistInput!
|
Parameters for CreateChecklist |
Example
Query
mutation createChecklist($input: CreateChecklistInput!) {
createChecklist(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
creator {
...UserFragment
}
id
name
tasks {
...TaskFragment
}
template
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateChecklistInput}
Response
{
"data": {
"createChecklist": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Checklist
}
}
}
createCheckoutSession
Response
Returns a CreateCheckoutSessionPayload
Arguments
| Name | Description |
|---|---|
input - CreateCheckoutSessionInput!
|
Parameters for CreateCheckoutSession |
Example
Query
mutation createCheckoutSession($input: CreateCheckoutSessionInput!) {
createCheckoutSession(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": CreateCheckoutSessionInput}
Response
{
"data": {
"createCheckoutSession": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": "abc123"
}
}
}
createComment
Response
Returns a CreateCommentPayload
Arguments
| Name | Description |
|---|---|
input - CreateCommentInput!
|
Parameters for CreateComment |
Example
Query
mutation createComment($input: CreateCommentInput!) {
createComment(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
author {
...UserFragment
}
commentableId
commentableType
content
createdAt
data {
...CommentDataEntryFragment
}
id
pinnedAt
reactions {
...ReactionFragment
}
systemGenerated
visibility
}
}
}
Variables
{"input": CreateCommentInput}
Response
{
"data": {
"createComment": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Comment
}
}
}
createDocument
Response
Returns a CreateDocumentPayload
Arguments
| Name | Description |
|---|---|
input - CreateDocumentInput!
|
Parameters for CreateDocument |
Example
Query
mutation createDocument($input: CreateDocumentInput!) {
createDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateDocumentInput}
Response
{
"data": {
"createDocument": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
}
}
createFeedback
Response
Returns a CreateFeedbackPayload
Arguments
| Name | Description |
|---|---|
input - CreateFeedbackInput!
|
Parameters for CreateFeedback |
Example
Query
mutation createFeedback($input: CreateFeedbackInput!) {
createFeedback(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": CreateFeedbackInput}
Response
{
"data": {
"createFeedback": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
}
}
createFolder
Response
Returns a CreateFolderPayload
Arguments
| Name | Description |
|---|---|
input - CreateFolderInput!
|
Parameters for CreateFolder |
Example
Query
mutation createFolder($input: CreateFolderInput!) {
createFolder(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateFolderInput}
Response
{
"data": {
"createFolder": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Folder
}
}
}
createGroups
Response
Returns a CreateGroupsPayload
Arguments
| Name | Description |
|---|---|
input - CreateGroupsInput!
|
Parameters for CreateGroups |
Example
Query
mutation createGroups($input: CreateGroupsInput!) {
createGroups(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
}
}
Variables
{"input": CreateGroupsInput}
Response
{
"data": {
"createGroups": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Group]
}
}
}
createJobSite
Response
Returns a CreateJobSitePayload
Arguments
| Name | Description |
|---|---|
input - CreateJobSiteInput!
|
Parameters for CreateJobSite |
Example
Query
mutation createJobSite($input: CreateJobSiteInput!) {
createJobSite(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
}
}
Variables
{"input": CreateJobSiteInput}
Response
{
"data": {
"createJobSite": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JobSite
}
}
}
createJoinCode
Response
Returns a CreateJoinCodePayload
Arguments
| Name | Description |
|---|---|
input - CreateJoinCodeInput!
|
Parameters for CreateJoinCode |
Example
Query
mutation createJoinCode($input: CreateJoinCodeInput!) {
createJoinCode(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
code
effectiveUntil
id
requireApproval
}
}
}
Variables
{"input": CreateJoinCodeInput}
Response
{
"data": {
"createJoinCode": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JoinCode
}
}
}
createJoinRequest
Response
Returns a CreateJoinRequestPayload
Arguments
| Name | Description |
|---|---|
input - CreateJoinRequestInput!
|
Parameters for CreateJoinRequest |
Example
Query
mutation createJoinRequest($input: CreateJoinRequestInput!) {
createJoinRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
state
user {
...UserFragment
}
userInfo
}
}
}
Variables
{"input": CreateJoinRequestInput}
Response
{
"data": {
"createJoinRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JoinRequest
}
}
}
createLeaveCategory
Response
Returns a CreateLeaveCategoryPayload
Arguments
| Name | Description |
|---|---|
input - CreateLeaveCategoryInput!
|
Parameters for CreateLeaveCategory |
Example
Query
mutation createLeaveCategory($input: CreateLeaveCategoryInput!) {
createLeaveCategory(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
enabled
id
name
paidLeave
unpaidLeave
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateLeaveCategoryInput}
Response
{
"data": {
"createLeaveCategory": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveCategory
}
}
}
createMessage
Response
Returns a CreateMessagePayload
Arguments
| Name | Description |
|---|---|
input - CreateMessageInput!
|
Parameters for CreateMessage |
Example
Query
mutation createMessage($input: CreateMessageInput!) {
createMessage(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": CreateMessageInput}
Response
{
"data": {
"createMessage": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatMessage
}
}
}
createMessageBoard
Response
Returns a CreateMessageBoardPayload
Arguments
| Name | Description |
|---|---|
input - CreateMessageBoardInput!
|
Parameters for CreateMessageBoard |
Example
Query
mutation createMessageBoard($input: CreateMessageBoardInput!) {
createMessageBoard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
categories {
...MessageBoardCategoryFragment
}
createdAt
deletedAt
description
id
messageBoardsMembers {
...MessageBoardsMemberFragment
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateMessageBoardInput}
Response
{
"data": {
"createMessageBoard": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoard
}
}
}
createMessageBoardPost
Response
Returns a CreateMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - CreateMessageBoardPostInput!
|
Parameters for CreateMessageBoardPost |
Example
Query
mutation createMessageBoardPost($input: CreateMessageBoardPostInput!) {
createMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": CreateMessageBoardPostInput}
Response
{
"data": {
"createMessageBoardPost": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
createReaction
Response
Returns a CreateReactionPayload
Arguments
| Name | Description |
|---|---|
input - CreateReactionInput!
|
Parameters for CreateReaction |
Example
Query
mutation createReaction($input: CreateReactionInput!) {
createReaction(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
creator {
...UserFragment
}
emoji
id
reactable {
... on Comment {
...CommentFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
}
updatedAt
}
}
}
Variables
{"input": CreateReactionInput}
Response
{
"data": {
"createReaction": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Reaction
}
}
}
createSchedule
Response
Returns a CreateSchedulePayload
Arguments
| Name | Description |
|---|---|
input - CreateScheduleInput!
|
Parameters for CreateSchedule |
Example
Query
mutation createSchedule($input: CreateScheduleInput!) {
createSchedule(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
}
}
Variables
{"input": CreateScheduleInput}
Response
{
"data": {
"createSchedule": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Schedule
}
}
}
createShift
Response
Returns a CreateShiftPayload
Arguments
| Name | Description |
|---|---|
input - CreateShiftInput!
|
Parameters for CreateShift |
Example
Query
mutation createShift($input: CreateShiftInput!) {
createShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateShiftInput}
Response
{
"data": {
"createShift": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
}
}
createShiftBatch
Response
Returns a CreateShiftBatchPayload
Arguments
| Name | Description |
|---|---|
input - CreateShiftBatchInput!
|
Parameters for CreateShiftBatch |
Example
Query
mutation createShiftBatch($input: CreateShiftBatchInput!) {
createShiftBatch(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
requester {
...UserFragment
}
shifts {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateShiftBatchInput}
Response
{
"data": {
"createShiftBatch": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftBatch
}
}
}
createShiftTemplate
Response
Returns a CreateShiftTemplatePayload
Arguments
| Name | Description |
|---|---|
input - CreateShiftTemplateInput!
|
Parameters for CreateShiftTemplate |
Example
Query
mutation createShiftTemplate($input: CreateShiftTemplateInput!) {
createShiftTemplate(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
breakDuration
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
name
note
schedule {
...ScheduleFragment
}
startTime
timezone
}
}
}
Variables
{"input": CreateShiftTemplateInput}
Response
{
"data": {
"createShiftTemplate": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftTemplate
}
}
}
createTag
Response
Returns a CreateTagPayload
Arguments
| Name | Description |
|---|---|
input - CreateTagInput!
|
Parameters for CreateTag |
Example
Query
mutation createTag($input: CreateTagInput!) {
createTag(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
}
}
}
Variables
{"input": CreateTagInput}
Response
{
"data": {
"createTag": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Tag
}
}
}
createTask
Response
Returns a CreateTaskPayload
Arguments
| Name | Description |
|---|---|
input - CreateTaskInput!
|
Parameters for CreateTask |
Example
Query
mutation createTask($input: CreateTaskInput!) {
createTask(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": CreateTaskInput}
Response
{
"data": {
"createTask": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Task
}
}
}
createTimeCard
Response
Returns a CreateTimeCardPayload
Arguments
| Name | Description |
|---|---|
input - CreateTimeCardInput!
|
Parameters for CreateTimeCard |
Example
Query
mutation createTimeCard($input: CreateTimeCardInput!) {
createTimeCard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
autoDeductedUnpaidBreakDuration
createdAt
creator {
...UserFragment
}
endTime
group {
...GroupFragment
}
hasWarning
id
note
punches {
...TimeCardPunchFragment
}
schedule {
...ScheduleFragment
}
shift {
...ShiftFragment
}
shiftId
startTime
state
timezone
totalDuration
}
}
}
Variables
{"input": CreateTimeCardInput}
Response
{
"data": {
"createTimeCard": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": TimeCard
}
}
}
createUsers
Response
Returns a CreateUsersPayload
Arguments
| Name | Description |
|---|---|
input - CreateUsersInput!
|
Parameters for CreateUsers |
Example
Query
mutation createUsers($input: CreateUsersInput!) {
createUsers(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"input": CreateUsersInput}
Response
{
"data": {
"createUsers": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [User]
}
}
}
createWorkspaceSampleData
Response
Returns a CreateWorkspaceSampleDataPayload
Arguments
| Name | Description |
|---|---|
input - CreateWorkspaceSampleDataInput!
|
Parameters for CreateWorkspaceSampleData |
Example
Query
mutation createWorkspaceSampleData($input: CreateWorkspaceSampleDataInput!) {
createWorkspaceSampleData(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": CreateWorkspaceSampleDataInput}
Response
{
"data": {
"createWorkspaceSampleData": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
}
}
deleteFiles
Response
Returns a DeleteFilesPayload
Arguments
| Name | Description |
|---|---|
input - DeleteFilesInput!
|
Parameters for DeleteFiles |
Example
Query
mutation deleteFiles($input: DeleteFilesInput!) {
deleteFiles(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": DeleteFilesInput}
Response
{
"data": {
"deleteFiles": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
}
}
destroyAvailability
Response
Returns a DestroyAvailabilityPayload
Arguments
| Name | Description |
|---|---|
input - DestroyAvailabilityInput!
|
Parameters for DestroyAvailability |
Example
Query
mutation destroyAvailability($input: DestroyAvailabilityInput!) {
destroyAvailability(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
from
id
note
recurrence {
...RecurrenceFragment
}
timezone
to
type
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": DestroyAvailabilityInput}
Response
{
"data": {
"destroyAvailability": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Availability
}
}
}
destroyCalendarEvent
Response
Returns a DestroyCalendarEventPayload
Arguments
| Name | Description |
|---|---|
input - DestroyCalendarEventInput!
|
Parameters for DestroyCalendarEvent |
Example
Query
mutation destroyCalendarEvent($input: DestroyCalendarEventInput!) {
destroyCalendarEvent(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
creator {
...UserFragment
}
eventType
from
id
note
recurrence {
...RecurrenceFragment
}
schedules {
...ScheduleFragment
}
state
timezone
to
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyCalendarEventInput}
Response
{
"data": {
"destroyCalendarEvent": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": CalendarEvent
}
}
}
destroyChecklist
Response
Returns a DestroyChecklistPayload
Arguments
| Name | Description |
|---|---|
input - DestroyChecklistInput!
|
Parameters for DestroyChecklist |
Example
Query
mutation destroyChecklist($input: DestroyChecklistInput!) {
destroyChecklist(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
creator {
...UserFragment
}
id
name
tasks {
...TaskFragment
}
template
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyChecklistInput}
Response
{
"data": {
"destroyChecklist": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Checklist
}
}
}
destroyComment
Response
Returns a DestroyCommentPayload
Arguments
| Name | Description |
|---|---|
input - DestroyCommentInput!
|
Parameters for DestroyComment |
Example
Query
mutation destroyComment($input: DestroyCommentInput!) {
destroyComment(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": DestroyCommentInput}
Response
{
"data": {
"destroyComment": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": false
}
}
}
destroyDocument
Response
Returns a DestroyDocumentPayload
Arguments
| Name | Description |
|---|---|
input - DestroyDocumentInput!
|
Parameters for DestroyDocument |
Example
Query
mutation destroyDocument($input: DestroyDocumentInput!) {
destroyDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyDocumentInput}
Response
{
"data": {
"destroyDocument": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
}
}
destroyFolder
Response
Returns a DestroyFolderPayload
Arguments
| Name | Description |
|---|---|
input - DestroyFolderInput!
|
Parameters for DestroyFolder |
Example
Query
mutation destroyFolder($input: DestroyFolderInput!) {
destroyFolder(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyFolderInput}
Response
{
"data": {
"destroyFolder": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Folder
}
}
}
destroyGroup
Response
Returns a DestroyGroupPayload
Arguments
| Name | Description |
|---|---|
input - DestroyGroupInput!
|
Parameters for DestroyGroup |
Example
Query
mutation destroyGroup($input: DestroyGroupInput!) {
destroyGroup(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
}
}
Variables
{"input": DestroyGroupInput}
Response
{
"data": {
"destroyGroup": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Group
}
}
}
destroyJobSite
Response
Returns a DestroyJobSitePayload
Arguments
| Name | Description |
|---|---|
input - DestroyJobSiteInput!
|
Parameters for DestroyJobSite |
Example
Query
mutation destroyJobSite($input: DestroyJobSiteInput!) {
destroyJobSite(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
}
}
Variables
{"input": DestroyJobSiteInput}
Response
{
"data": {
"destroyJobSite": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JobSite
}
}
}
destroyJoinCode
Response
Returns a DestroyJoinCodePayload
Arguments
| Name | Description |
|---|---|
input - DestroyJoinCodeInput!
|
Parameters for DestroyJoinCode |
Example
Query
mutation destroyJoinCode($input: DestroyJoinCodeInput!) {
destroyJoinCode(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
code
effectiveUntil
id
requireApproval
}
}
}
Variables
{"input": DestroyJoinCodeInput}
Response
{
"data": {
"destroyJoinCode": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JoinCode
}
}
}
destroyLeave
Response
Returns a DestroyLeavePayload
Arguments
| Name | Description |
|---|---|
input - DestroyLeaveInput!
|
Parameters for DestroyLeave |
Example
Query
mutation destroyLeave($input: DestroyLeaveInput!) {
destroyLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyLeaveInput}
Response
{
"data": {
"destroyLeave": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
destroyMessage
Response
Returns a DestroyMessagePayload
Arguments
| Name | Description |
|---|---|
input - DestroyMessageInput!
|
Parameters for DestroyMessage |
Example
Query
mutation destroyMessage($input: DestroyMessageInput!) {
destroyMessage(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": DestroyMessageInput}
Response
{
"data": {
"destroyMessage": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatMessage
}
}
}
destroyMessageBoard
Response
Returns a DestroyMessageBoardPayload
Arguments
| Name | Description |
|---|---|
input - DestroyMessageBoardInput!
|
Parameters for DestroyMessageBoard |
Example
Query
mutation destroyMessageBoard($input: DestroyMessageBoardInput!) {
destroyMessageBoard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
categories {
...MessageBoardCategoryFragment
}
createdAt
deletedAt
description
id
messageBoardsMembers {
...MessageBoardsMemberFragment
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyMessageBoardInput}
Response
{
"data": {
"destroyMessageBoard": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoard
}
}
}
destroyMessageBoardPost
Response
Returns a DestroyMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - DestroyMessageBoardPostInput!
|
Parameters for DestroyMessageBoardPost |
Example
Query
mutation destroyMessageBoardPost($input: DestroyMessageBoardPostInput!) {
destroyMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": DestroyMessageBoardPostInput}
Response
{
"data": {
"destroyMessageBoardPost": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
destroyReaction
Response
Returns a DestroyReactionPayload
Arguments
| Name | Description |
|---|---|
input - DestroyReactionInput!
|
Parameters for DestroyReaction |
Example
Query
mutation destroyReaction($input: DestroyReactionInput!) {
destroyReaction(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": DestroyReactionInput}
Response
{
"data": {
"destroyReaction": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": false
}
}
}
destroySchedule
Response
Returns a DestroySchedulePayload
Arguments
| Name | Description |
|---|---|
input - DestroyScheduleInput!
|
Parameters for DestroySchedule |
Example
Query
mutation destroySchedule($input: DestroyScheduleInput!) {
destroySchedule(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
}
}
Variables
{"input": DestroyScheduleInput}
Response
{
"data": {
"destroySchedule": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Schedule
}
}
}
destroySchedulePhoto
Response
Returns a DestroySchedulePhotoPayload
Arguments
| Name | Description |
|---|---|
input - DestroySchedulePhotoInput!
|
Parameters for DestroySchedulePhoto |
Example
Query
mutation destroySchedulePhoto($input: DestroySchedulePhotoInput!) {
destroySchedulePhoto(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
from
id
photo
schedule {
...ScheduleFragment
}
timezone
to
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroySchedulePhotoInput}
Response
{
"data": {
"destroySchedulePhoto": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": SchedulePhoto
}
}
}
destroyShift
Response
Returns a DestroyShiftPayload
Arguments
| Name | Description |
|---|---|
input - DestroyShiftInput!
|
Parameters for DestroyShift |
Example
Query
mutation destroyShift($input: DestroyShiftInput!) {
destroyShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyShiftInput}
Response
{
"data": {
"destroyShift": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
}
}
destroyShiftBatch
Response
Returns a DestroyShiftBatchPayload
Arguments
| Name | Description |
|---|---|
input - DestroyShiftBatchInput!
|
Parameters for DestroyShiftBatch |
Example
Query
mutation destroyShiftBatch($input: DestroyShiftBatchInput!) {
destroyShiftBatch(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
requester {
...UserFragment
}
shifts {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyShiftBatchInput}
Response
{
"data": {
"destroyShiftBatch": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftBatch
}
}
}
destroyShiftOffer
Response
Returns a DestroyShiftOfferPayload
Arguments
| Name | Description |
|---|---|
input - DestroyShiftOfferInput!
|
Parameters for DestroyShiftOffer |
Example
Query
mutation destroyShiftOffer($input: DestroyShiftOfferInput!) {
destroyShiftOffer(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftOfferRequests {
...ShiftOfferRequestFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyShiftOfferInput}
Response
{
"data": {
"destroyShiftOffer": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftOffer
}
}
}
destroyShiftSwap
Response
Returns a DestroyShiftSwapPayload
Arguments
| Name | Description |
|---|---|
input - DestroyShiftSwapInput!
|
Parameters for DestroyShiftSwap |
Example
Query
mutation destroyShiftSwap($input: DestroyShiftSwapInput!) {
destroyShiftSwap(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
shiftSwapRequests {
...ShiftSwapRequestFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyShiftSwapInput}
Response
{
"data": {
"destroyShiftSwap": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftSwap
}
}
}
destroyShiftTemplate
Response
Returns a DestroyShiftTemplatePayload
Arguments
| Name | Description |
|---|---|
input - DestroyShiftTemplateInput!
|
Parameters for DestroyShiftTemplate |
Example
Query
mutation destroyShiftTemplate($input: DestroyShiftTemplateInput!) {
destroyShiftTemplate(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
breakDuration
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
name
note
schedule {
...ScheduleFragment
}
startTime
timezone
}
}
}
Variables
{"input": DestroyShiftTemplateInput}
Response
{
"data": {
"destroyShiftTemplate": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftTemplate
}
}
}
destroyShifts
Response
Returns a DestroyShiftsPayload
Arguments
| Name | Description |
|---|---|
input - DestroyShiftsInput!
|
Parameters for DestroyShifts |
Example
Query
mutation destroyShifts($input: DestroyShiftsInput!) {
destroyShifts(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyShiftsInput}
Response
{
"data": {
"destroyShifts": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Shift]
}
}
}
destroyTask
Response
Returns a DestroyTaskPayload
Arguments
| Name | Description |
|---|---|
input - DestroyTaskInput!
|
Parameters for DestroyTask |
Example
Query
mutation destroyTask($input: DestroyTaskInput!) {
destroyTask(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": DestroyTaskInput}
Response
{
"data": {
"destroyTask": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": false
}
}
}
destroyTimeCard
Response
Returns a DestroyTimeCardPayload
Arguments
| Name | Description |
|---|---|
input - DestroyTimeCardInput!
|
Parameters for DestroyTimeCard |
Example
Query
mutation destroyTimeCard($input: DestroyTimeCardInput!) {
destroyTimeCard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
autoDeductedUnpaidBreakDuration
createdAt
creator {
...UserFragment
}
endTime
group {
...GroupFragment
}
hasWarning
id
note
punches {
...TimeCardPunchFragment
}
schedule {
...ScheduleFragment
}
shift {
...ShiftFragment
}
shiftId
startTime
state
timezone
totalDuration
}
}
}
Variables
{"input": DestroyTimeCardInput}
Response
{
"data": {
"destroyTimeCard": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": TimeCard
}
}
}
destroyTimesheet
Response
Returns a DestroyTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - DestroyTimesheetInput!
|
Parameters for DestroyTimesheet |
Example
Query
mutation destroyTimesheet($input: DestroyTimesheetInput!) {
destroyTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DestroyTimesheetInput}
Response
{
"data": {
"destroyTimesheet": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
}
}
destroyWorkspaceSampleData
Response
Returns a DestroyWorkspaceSampleDataPayload
Arguments
| Name | Description |
|---|---|
input - DestroyWorkspaceSampleDataInput!
|
Parameters for DestroyWorkspaceSampleData |
Example
Query
mutation destroyWorkspaceSampleData($input: DestroyWorkspaceSampleDataInput!) {
destroyWorkspaceSampleData(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": DestroyWorkspaceSampleDataInput}
Response
{
"data": {
"destroyWorkspaceSampleData": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": true
}
}
}
downgradeSubscriptionPlan
Response
Returns a DowngradeSubscriptionPlanPayload
Arguments
| Name | Description |
|---|---|
input - DowngradeSubscriptionPlanInput!
|
Parameters for DowngradeSubscriptionPlan |
Example
Query
mutation downgradeSubscriptionPlan($input: DowngradeSubscriptionPlanInput!) {
downgradeSubscriptionPlan(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": DowngradeSubscriptionPlanInput}
Response
{
"data": {
"downgradeSubscriptionPlan": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
}
}
downloadFile
Response
Returns a DownloadFilePayload
Arguments
| Name | Description |
|---|---|
input - DownloadFileInput!
|
Parameters for DownloadFile |
Example
Query
mutation downloadFile($input: DownloadFileInput!) {
downloadFile(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
url
}
}
}
Variables
{"input": DownloadFileInput}
Response
{
"data": {
"downloadFile": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": DownloadFileResult
}
}
}
draftLeave
Response
Returns a DraftLeavePayload
Arguments
| Name | Description |
|---|---|
input - DraftLeaveInput!
|
Parameters for DraftLeave |
Example
Query
mutation draftLeave($input: DraftLeaveInput!) {
draftLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DraftLeaveInput}
Response
{
"data": {
"draftLeave": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
draftTimesheet
Response
Returns a DraftTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - DraftTimesheetInput!
|
Parameters for DraftTimesheet |
Example
Query
mutation draftTimesheet($input: DraftTimesheetInput!) {
draftTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": DraftTimesheetInput}
Response
{
"data": {
"draftTimesheet": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
}
}
exportSchedule
Description
Export schedule as spreadsheet/image file and send email to owner
Response
Returns an ExportSchedulePayload
Arguments
| Name | Description |
|---|---|
input - ExportScheduleInput!
|
Parameters for ExportSchedule |
Example
Query
mutation exportSchedule($input: ExportScheduleInput!) {
exportSchedule(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": ExportScheduleInput}
Response
{
"data": {
"exportSchedule": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
}
}
exportTimesheet
Description
Export timesheet as xlsx file and send email to customer
Response
Returns an ExportTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - ExportTimesheetInput!
|
Parameters for ExportTimesheet |
Example
Query
mutation exportTimesheet($input: ExportTimesheetInput!) {
exportTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": ExportTimesheetInput}
Response
{
"data": {
"exportTimesheet": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
}
}
finishEmployeeGetStartedStep
Response
Returns a FinishEmployeeGetStartedStepPayload
Arguments
| Name | Description |
|---|---|
input - FinishEmployeeGetStartedStepInput!
|
Parameters for FinishEmployeeGetStartedStep |
Example
Query
mutation finishEmployeeGetStartedStep($input: FinishEmployeeGetStartedStepInput!) {
finishEmployeeGetStartedStep(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
name
order
state
}
}
}
Variables
{"input": FinishEmployeeGetStartedStepInput}
Response
{
"data": {
"finishEmployeeGetStartedStep": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": EmployeeGetStartedStep
}
}
}
finishTask
Response
Returns a FinishTaskPayload
Arguments
| Name | Description |
|---|---|
input - FinishTaskInput!
|
Parameters for FinishTask |
Example
Query
mutation finishTask($input: FinishTaskInput!) {
finishTask(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": FinishTaskInput}
Response
{
"data": {
"finishTask": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Task
}
}
}
finishWorkspaceGetStartedStep
Response
Returns a FinishWorkspaceGetStartedStepPayload
Arguments
| Name | Description |
|---|---|
input - FinishWorkspaceGetStartedStepInput!
|
Parameters for FinishWorkspaceGetStartedStep |
Example
Query
mutation finishWorkspaceGetStartedStep($input: FinishWorkspaceGetStartedStepInput!) {
finishWorkspaceGetStartedStep(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
name
order
state
}
}
}
Variables
{"input": FinishWorkspaceGetStartedStepInput}
Response
{
"data": {
"finishWorkspaceGetStartedStep": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": WorkspaceGetStartedStep
}
}
}
generateUploadUrl
Response
Returns a GenerateDirectUploadUrlPayload
Arguments
| Name | Description |
|---|---|
input - GenerateDirectUploadUrlInput!
|
Parameters for GenerateDirectUploadUrl |
Example
Query
mutation generateUploadUrl($input: GenerateDirectUploadUrlInput!) {
generateUploadUrl(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acl
key
policy
uri
xAmzAlgorithm
xAmzCredential
xAmzDate
xAmzSignature
}
}
}
Variables
{"input": GenerateDirectUploadUrlInput}
Response
{
"data": {
"generateUploadUrl": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": AWS4Request
}
}
}
importEmployees
Description
Import employees to workspace
Response
Returns an ImportEmployeesPayload
Arguments
| Name | Description |
|---|---|
input - ImportEmployeesInput!
|
Parameters for ImportEmployees |
Example
Query
mutation importEmployees($input: ImportEmployeesInput!) {
importEmployees(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
csvFile
data
id
requester {
...UserFragment
}
state
updatedAt
}
}
}
Variables
{"input": ImportEmployeesInput}
Response
{
"data": {
"importEmployees": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": EmployeeImportRequest
}
}
}
inviteToChannel
Response
Returns an InviteToChannelPayload
Arguments
| Name | Description |
|---|---|
input - InviteToChannelInput!
|
Parameters for InviteToChannel |
Example
Query
mutation inviteToChannel($input: InviteToChannelInput!) {
inviteToChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": InviteToChannelInput}
Response
{
"data": {
"inviteToChannel": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatChannel
}
}
}
joinChannel
Response
Returns a JoinChannelPayload
Arguments
| Name | Description |
|---|---|
input - JoinChannelInput!
|
Parameters for JoinChannel |
Example
Query
mutation joinChannel($input: JoinChannelInput!) {
joinChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": JoinChannelInput}
Response
{
"data": {
"joinChannel": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChannelMember
}
}
}
kickFromChannel
Response
Returns a KickFromChannelPayload
Arguments
| Name | Description |
|---|---|
input - KickFromChannelInput!
|
Parameters for KickFromChannel |
Example
Query
mutation kickFromChannel($input: KickFromChannelInput!) {
kickFromChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": KickFromChannelInput}
Response
{
"data": {
"kickFromChannel": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatChannel
}
}
}
kioskPunch
Response
Returns a KioskPunchPayload
Arguments
| Name | Description |
|---|---|
input - KioskPunchInput!
|
Parameters for KioskPunch |
Example
Query
mutation kioskPunch($input: KioskPunchInput!) {
kioskPunch(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
state
timeCards {
...KioskTimeCardFragment
}
whoami {
...WhoamiFragment
}
}
}
}
Variables
{"input": KioskPunchInput}
Response
{
"data": {
"kioskPunch": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": KioskPunchResponse
}
}
}
lastViewedAtChannel
Description
Set the last time the user has viewed the channel
Response
Returns a LastViewedAtChannelPayload
Arguments
| Name | Description |
|---|---|
input - LastViewedAtChannelInput!
|
Parameters for LastViewedAtChannel |
Example
Query
mutation lastViewedAtChannel($input: LastViewedAtChannelInput!) {
lastViewedAtChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": LastViewedAtChannelInput}
Response
{
"data": {
"lastViewedAtChannel": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChannelMember
}
}
}
leaveChannel
Response
Returns a LeaveChannelPayload
Arguments
| Name | Description |
|---|---|
input - LeaveChannelInput!
|
Parameters for LeaveChannel |
Example
Query
mutation leaveChannel($input: LeaveChannelInput!) {
leaveChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": LeaveChannelInput}
Response
{
"data": {
"leaveChannel": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChannelMember
}
}
}
linkWithDevice
Description
Link the Device with current user for notifications receiving
Response
Returns a LinkUserWithDevicePayload
Arguments
| Name | Description |
|---|---|
input - LinkUserWithDeviceInput!
|
Parameters for LinkUserWithDevice |
Example
Query
mutation linkWithDevice($input: LinkUserWithDeviceInput!) {
linkWithDevice(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
appVersion
buildVersion
id
name
token
user {
...UserFragment
}
}
}
}
Variables
{"input": LinkUserWithDeviceInput}
Response
{
"data": {
"linkWithDevice": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Device
}
}
}
markAllInboxAsRead
Response
Returns a MarkAllInboxAsReadPayload
Arguments
| Name | Description |
|---|---|
input - MarkAllInboxAsReadInput!
|
Parameters for MarkAllInboxAsRead |
Example
Query
mutation markAllInboxAsRead($input: MarkAllInboxAsReadInput!) {
markAllInboxAsRead(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": MarkAllInboxAsReadInput}
Response
{
"data": {
"markAllInboxAsRead": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [ChatMessage]
}
}
}
markAllNotificationsAsRead
Response
Returns a MarkAllNotificationsAsReadPayload
Arguments
| Name | Description |
|---|---|
input - MarkAllNotificationsAsReadInput!
|
Parameters for MarkAllNotificationsAsRead |
Example
Query
mutation markAllNotificationsAsRead($input: MarkAllNotificationsAsReadInput!) {
markAllNotificationsAsRead(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": MarkAllNotificationsAsReadInput}
Response
{
"data": {
"markAllNotificationsAsRead": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": false
}
}
}
markNotificationsAsRead
Response
Returns a MarkNotificationsAsReadPayload
Arguments
| Name | Description |
|---|---|
input - MarkNotificationsAsReadInput!
|
Parameters for MarkNotificationsAsRead |
Example
Query
mutation markNotificationsAsRead($input: MarkNotificationsAsReadInput!) {
markNotificationsAsRead(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
actedUponAt
createdAt
id
message
notificationType
readAt
recipient {
...UserFragment
}
recipientId
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
sender {
...UserFragment
}
senderId
title
updatedAt
workspaceId
}
}
}
Variables
{"input": MarkNotificationsAsReadInput}
Response
{
"data": {
"markNotificationsAsRead": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Notification]
}
}
}
messageAction
Response
Returns a MessageActionPayload
Arguments
| Name | Description |
|---|---|
input - MessageActionInput!
|
Parameters for MessageAction |
Example
Query
mutation messageAction($input: MessageActionInput!) {
messageAction(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
blocks
message
responseType
}
}
}
Variables
{"input": MessageActionInput}
Response
{
"data": {
"messageAction": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageActionResult
}
}
}
offerShift
Response
Returns an OfferShiftPayload
Arguments
| Name | Description |
|---|---|
input - OfferShiftInput!
|
Parameters for OfferShift |
Example
Query
mutation offerShift($input: OfferShiftInput!) {
offerShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": OfferShiftInput}
Response
{
"data": {
"offerShift": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
}
}
pinDocument
Response
Returns a PinDocumentPayload
Arguments
| Name | Description |
|---|---|
input - PinDocumentInput!
|
Parameters for PinDocument |
Example
Query
mutation pinDocument($input: PinDocumentInput!) {
pinDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": PinDocumentInput}
Response
{
"data": {
"pinDocument": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
}
}
pinMessageBoard
Response
Returns a PinMessageBoardPayload
Arguments
| Name | Description |
|---|---|
input - PinMessageBoardInput!
|
Parameters for PinMessageBoard |
Example
Query
mutation pinMessageBoard($input: PinMessageBoardInput!) {
pinMessageBoard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
categories {
...MessageBoardCategoryFragment
}
createdAt
deletedAt
description
id
messageBoardsMembers {
...MessageBoardsMemberFragment
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": PinMessageBoardInput}
Response
{
"data": {
"pinMessageBoard": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoard
}
}
}
pinMessageBoardPost
Response
Returns a PinMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - PinMessageBoardPostInput!
|
Parameters for PinMessageBoardPost |
Example
Query
mutation pinMessageBoardPost($input: PinMessageBoardPostInput!) {
pinMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": PinMessageBoardPostInput}
Response
{
"data": {
"pinMessageBoardPost": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
publishShifts
Response
Returns a PublishShiftsPayload
Arguments
| Name | Description |
|---|---|
input - PublishShiftsInput!
|
Parameters for PublishShifts |
Example
Query
mutation publishShifts($input: PublishShiftsInput!) {
publishShifts(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": PublishShiftsInput}
Response
{
"data": {
"publishShifts": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Shift]
}
}
}
readInboxMessage
Response
Returns a ReadInboxMessagePayload
Arguments
| Name | Description |
|---|---|
input - ReadInboxMessageInput!
|
Parameters for ReadInboxMessage |
Example
Query
mutation readInboxMessage($input: ReadInboxMessageInput!) {
readInboxMessage(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": ReadInboxMessageInput}
Response
{
"data": {
"readInboxMessage": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatMessage
}
}
}
reassignShift
Response
Returns a ReassignShiftPayload
Arguments
| Name | Description |
|---|---|
input - ReassignShiftInput!
|
Parameters for ReassignShift |
Example
Query
mutation reassignShift($input: ReassignShiftInput!) {
reassignShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ReassignShiftInput}
Response
{
"data": {
"reassignShift": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
}
}
redeemCode
Response
Returns a RedeemCodePayload
Arguments
| Name | Description |
|---|---|
input - RedeemCodeInput!
|
Parameters for RedeemCode |
Example
Query
mutation redeemCode($input: RedeemCodeInput!) {
redeemCode(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
redeemedAt
}
}
}
Variables
{"input": RedeemCodeInput}
Response
{
"data": {
"redeemCode": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Redemption
}
}
}
refuseShiftOfferRequest
Response
Returns a RefuseShiftOfferRequestPayload
Arguments
| Name | Description |
|---|---|
input - RefuseShiftOfferRequestInput!
|
Parameters for RefuseShiftOfferRequest |
Example
Query
mutation refuseShiftOfferRequest($input: RefuseShiftOfferRequestInput!) {
refuseShiftOfferRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftOffer {
...ShiftOfferFragment
}
state
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RefuseShiftOfferRequestInput}
Response
{
"data": {
"refuseShiftOfferRequest": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftOfferRequest
}
}
}
refuseShiftSwapRequest
Response
Returns a RefuseShiftSwapRequestPayload
Arguments
| Name | Description |
|---|---|
input - RefuseShiftSwapRequestInput!
|
Parameters for RefuseShiftSwapRequest |
Example
Query
mutation refuseShiftSwapRequest($input: RefuseShiftSwapRequestInput!) {
refuseShiftSwapRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acceptedAt
approvedAt
approver {
...UserFragment
}
createdAt
id
receiver {
...UserFragment
}
refusedAt
rejectedAt
shiftSwap {
...ShiftSwapFragment
}
state
targetShift {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RefuseShiftSwapRequestInput}
Response
{
"data": {
"refuseShiftSwapRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftSwapRequest
}
}
}
rejectJoinRequest
Response
Returns a RejectJoinRequestPayload
Arguments
| Name | Description |
|---|---|
input - RejectJoinRequestInput!
|
Parameters for RejectJoinRequest |
Example
Query
mutation rejectJoinRequest($input: RejectJoinRequestInput!) {
rejectJoinRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
state
user {
...UserFragment
}
userInfo
}
}
}
Variables
{"input": RejectJoinRequestInput}
Response
{
"data": {
"rejectJoinRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JoinRequest
}
}
}
rejectLeave
Response
Returns a RejectLeavePayload
Arguments
| Name | Description |
|---|---|
input - RejectLeaveInput!
|
Parameters for RejectLeave |
Example
Query
mutation rejectLeave($input: RejectLeaveInput!) {
rejectLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RejectLeaveInput}
Response
{
"data": {
"rejectLeave": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
rejectShift
Response
Returns a RejectShiftPayload
Arguments
| Name | Description |
|---|---|
input - RejectShiftInput!
|
Parameters for RejectShift |
Example
Query
mutation rejectShift($input: RejectShiftInput!) {
rejectShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RejectShiftInput}
Response
{
"data": {
"rejectShift": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
}
}
rejectShiftClaimRequest
Response
Returns a RejectShiftClaimRequestPayload
Arguments
| Name | Description |
|---|---|
input - RejectShiftClaimRequestInput!
|
Parameters for RejectShiftClaimRequest |
Example
Query
mutation rejectShiftClaimRequest($input: RejectShiftClaimRequestInput!) {
rejectShiftClaimRequest(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
requester {
...UserFragment
}
shift {
...ShiftFragment
}
state
}
}
}
Variables
{"input": RejectShiftClaimRequestInput}
Response
{
"data": {
"rejectShiftClaimRequest": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftClaimRequest
}
}
}
rejectTimesheet
Response
Returns a RejectTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - RejectTimesheetInput!
|
Parameters for RejectTimesheet |
Example
Query
mutation rejectTimesheet($input: RejectTimesheetInput!) {
rejectTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RejectTimesheetInput}
Response
{
"data": {
"rejectTimesheet": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
}
}
requestKioskLoginSession
Description
Open a login request for the kiosk app, only send OTP if the requester is owner/managers.
Response
Returns a RequestKioskLoginSessionPayload
Arguments
| Name | Description |
|---|---|
input - RequestKioskLoginSessionInput!
|
Parameters for RequestKioskLoginSession |
Example
Query
mutation requestKioskLoginSession($input: RequestKioskLoginSessionInput!) {
requestKioskLoginSession(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
uad
}
}
}
Variables
{"input": RequestKioskLoginSessionInput}
Response
{
"data": {
"requestKioskLoginSession": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LoginSession
}
}
}
requestLoginSession
Description
Open a login request, the user will be verified through OTP.
Response
Returns a RequestLoginSessionPayload
Arguments
| Name | Description |
|---|---|
input - RequestLoginSessionInput!
|
Parameters for RequestLoginSession |
Example
Query
mutation requestLoginSession($input: RequestLoginSessionInput!) {
requestLoginSession(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
uad
}
}
}
Variables
{"input": RequestLoginSessionInput}
Response
{
"data": {
"requestLoginSession": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LoginSession
}
}
}
requestServiceToken
Response
Returns a RequestServiceTokenPayload
Arguments
| Name | Description |
|---|---|
input - RequestServiceTokenInput!
|
Parameters for RequestServiceToken |
Example
Query
mutation requestServiceToken($input: RequestServiceTokenInput!) {
requestServiceToken(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": RequestServiceTokenInput}
Response
{
"data": {
"requestServiceToken": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": "xyz789"
}
}
}
requestToDestroyUser
Response
Returns a RequestToDestroyUserPayload
Arguments
| Name | Description |
|---|---|
input - RequestToDestroyUserInput!
|
Parameters for RequestToDestroyUser |
Example
Query
mutation requestToDestroyUser($input: RequestToDestroyUserInput!) {
requestToDestroyUser(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": RequestToDestroyUserInput}
Response
{
"data": {
"requestToDestroyUser": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
}
}
restoreDocument
Response
Returns a RestoreDocumentPayload
Arguments
| Name | Description |
|---|---|
input - RestoreDocumentInput!
|
Parameters for RestoreDocument |
Example
Query
mutation restoreDocument($input: RestoreDocumentInput!) {
restoreDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RestoreDocumentInput}
Response
{
"data": {
"restoreDocument": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
}
}
restoreGroup
Response
Returns a RestoreGroupPayload
Arguments
| Name | Description |
|---|---|
input - RestoreGroupInput!
|
Parameters for RestoreGroup |
Example
Query
mutation restoreGroup($input: RestoreGroupInput!) {
restoreGroup(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
}
}
Variables
{"input": RestoreGroupInput}
Response
{
"data": {
"restoreGroup": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Group
}
}
}
resubmitLeave
Response
Returns a ResubmitLeavePayload
Arguments
| Name | Description |
|---|---|
input - ResubmitLeaveInput!
|
Parameters for ResubmitLeave |
Example
Query
mutation resubmitLeave($input: ResubmitLeaveInput!) {
resubmitLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ResubmitLeaveInput}
Response
{
"data": {
"resubmitLeave": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
resubmitTimesheet
Response
Returns a ResubmitTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - ResubmitTimesheetInput!
|
Parameters for ResubmitTimesheet |
Example
Query
mutation resubmitTimesheet($input: ResubmitTimesheetInput!) {
resubmitTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": ResubmitTimesheetInput}
Response
{
"data": {
"resubmitTimesheet": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
}
}
roundTimesheet
Response
Returns a RoundTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - RoundTimesheetInput!
|
Parameters for RoundTimesheet |
Example
Query
mutation roundTimesheet($input: RoundTimesheetInput!) {
roundTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": RoundTimesheetInput}
Response
{
"data": {
"roundTimesheet": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
}
}
saveTrialPersonalization
Response
Returns a SaveTrialPersonalizationPayload
Arguments
| Name | Description |
|---|---|
input - SaveTrialPersonalizationInput!
|
Parameters for SaveTrialPersonalization |
Example
Query
mutation saveTrialPersonalization($input: SaveTrialPersonalizationInput!) {
saveTrialPersonalization(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": SaveTrialPersonalizationInput}
Response
{
"data": {
"saveTrialPersonalization": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": "4"
}
}
}
signUp
Response
Returns a SignUpPayload
Arguments
| Name | Description |
|---|---|
input - SignUpInput!
|
Parameters for SignUp |
Example
Query
mutation signUp($input: SignUpInput!) {
signUp(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
prospectId
workspaceId
}
}
}
Variables
{"input": SignUpInput}
Response
{
"data": {
"signUp": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": SignupProspectResult
}
}
}
signupWorkspace
Response
Returns a SignupWorkspacePayload
Arguments
| Name | Description |
|---|---|
input - SignupWorkspaceInput!
|
Parameters for SignupWorkspace |
Example
Query
mutation signupWorkspace($input: SignupWorkspaceInput!) {
signupWorkspace(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
jwtPayload {
...JwtPayloadFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SignupWorkspaceInput}
Response
{
"data": {
"signupWorkspace": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": SignupWorkspaceResult
}
}
}
startTask
Response
Returns a StartTaskPayload
Arguments
| Name | Description |
|---|---|
input - StartTaskInput!
|
Parameters for StartTask |
Example
Query
mutation startTask($input: StartTaskInput!) {
startTask(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": StartTaskInput}
Response
{
"data": {
"startTask": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Task
}
}
}
submitDraftLeave
Response
Returns a SubmitDraftLeavePayload
Arguments
| Name | Description |
|---|---|
input - SubmitDraftLeaveInput!
|
Parameters for SubmitDraftLeave |
Example
Query
mutation submitDraftLeave($input: SubmitDraftLeaveInput!) {
submitDraftLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SubmitDraftLeaveInput}
Response
{
"data": {
"submitDraftLeave": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
submitDraftTimesheet
Response
Returns a SubmitDraftTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - SubmitDraftTimesheetInput!
|
Parameters for SubmitDraftTimesheet |
Example
Query
mutation submitDraftTimesheet($input: SubmitDraftTimesheetInput!) {
submitDraftTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SubmitDraftTimesheetInput}
Response
{
"data": {
"submitDraftTimesheet": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
}
}
submitDraftTimesheets
Response
Returns a SubmitDraftTimesheetsPayload
Arguments
| Name | Description |
|---|---|
input - SubmitDraftTimesheetsInput!
|
Parameters for SubmitDraftTimesheets |
Example
Query
mutation submitDraftTimesheets($input: SubmitDraftTimesheetsInput!) {
submitDraftTimesheets(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SubmitDraftTimesheetsInput}
Response
{
"data": {
"submitDraftTimesheets": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Timesheet]
}
}
}
submitLeave
Response
Returns a SubmitLeavePayload
Arguments
| Name | Description |
|---|---|
input - SubmitLeaveInput!
|
Parameters for SubmitLeave |
Example
Query
mutation submitLeave($input: SubmitLeaveInput!) {
submitLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SubmitLeaveInput}
Response
{
"data": {
"submitLeave": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
submitTimesheet
Response
Returns a SubmitTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - SubmitTimesheetInput!
|
Parameters for SubmitTimesheet |
Example
Query
mutation submitTimesheet($input: SubmitTimesheetInput!) {
submitTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SubmitTimesheetInput}
Response
{
"data": {
"submitTimesheet": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
}
}
swapShift
Response
Returns a SwapShiftPayload
Arguments
| Name | Description |
|---|---|
input - SwapShiftInput!
|
Parameters for SwapShift |
Example
Query
mutation swapShift($input: SwapShiftInput!) {
swapShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": SwapShiftInput}
Response
{
"data": {
"swapShift": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
}
}
syncTimeCardPunchAttachment
Description
Sync time_card punch's attachment
Response
Returns a SyncTimeCardPunchAttachmentPayload
Arguments
| Name | Description |
|---|---|
input - SyncTimeCardPunchAttachmentInput!
|
Parameters for SyncTimeCardPunchAttachment |
Example
Query
mutation syncTimeCardPunchAttachment($input: SyncTimeCardPunchAttachmentInput!) {
syncTimeCardPunchAttachment(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
atTime
createdAt
geoLat
geoLong
id
photo
photoToken
timeCardId
updatedAt
wifiBssid
wifiSsid
}
}
}
Variables
{"input": SyncTimeCardPunchAttachmentInput}
Response
{
"data": {
"syncTimeCardPunchAttachment": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": TimeCardPunchAttachment
}
}
}
syncTimeCardPunches
Description
Sync time_card clock in/out punches. If one punch is failed to sync, the rest will be halted.
Response
Returns a SyncTimeCardPunchesPayload
Arguments
| Name | Description |
|---|---|
input - SyncTimeCardPunchesInput!
|
Parameters for SyncTimeCardPunches |
Example
Query
mutation syncTimeCardPunches($input: SyncTimeCardPunchesInput!) {
syncTimeCardPunches(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
atTime
attachment {
...TimeCardPunchAttachmentFragment
}
createdAt
id
note
punchType
timeCardId
updatedAt
warnings {
...TimeCardPunchWarningFragment
}
}
}
}
Variables
{"input": SyncTimeCardPunchesInput}
Response
{
"data": {
"syncTimeCardPunches": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [TimeCardPunch]
}
}
}
toggleReaction
Response
Returns a ToggleReactionPayload
Arguments
| Name | Description |
|---|---|
input - ToggleReactionInput!
|
Parameters for ToggleReaction |
Example
Query
mutation toggleReaction($input: ToggleReactionInput!) {
toggleReaction(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": ToggleReactionInput}
Response
{
"data": {
"toggleReaction": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatMessage
}
}
}
unacknowledgeDocument
Response
Returns an UnacknowledgeDocumentPayload
Arguments
| Name | Description |
|---|---|
input - UnacknowledgeDocumentInput!
|
Parameters for UnacknowledgeDocument |
Example
Query
mutation unacknowledgeDocument($input: UnacknowledgeDocumentInput!) {
unacknowledgeDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UnacknowledgeDocumentInput}
Response
{
"data": {
"unacknowledgeDocument": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
}
}
unarchiveChannel
Response
Returns an UnarchiveChannelPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveChannelInput!
|
Parameters for UnarchiveChannel |
Example
Query
mutation unarchiveChannel($input: UnarchiveChannelInput!) {
unarchiveChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UnarchiveChannelInput}
Response
{
"data": {
"unarchiveChannel": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatChannel
}
}
}
unarchiveMember
Response
Returns an UnarchiveMemberPayload
Arguments
| Name | Description |
|---|---|
input - UnarchiveMemberInput!
|
Parameters for UnarchiveMember |
Example
Query
mutation unarchiveMember($input: UnarchiveMemberInput!) {
unarchiveMember(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": UnarchiveMemberInput}
Response
{
"data": {
"unarchiveMember": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": "abc123"
}
}
}
unconfirmMessageBoardPost
Response
Returns an UnconfirmMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - UnconfirmMessageBoardPostInput!
|
Parameters for UnconfirmMessageBoardPost |
Example
Query
mutation unconfirmMessageBoardPost($input: UnconfirmMessageBoardPostInput!) {
unconfirmMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": UnconfirmMessageBoardPostInput}
Response
{
"data": {
"unconfirmMessageBoardPost": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
undoFinishTask
Response
Returns an UndoFinishTaskPayload
Arguments
| Name | Description |
|---|---|
input - UndoFinishTaskInput!
|
Parameters for UndoFinishTask |
Example
Query
mutation undoFinishTask($input: UndoFinishTaskInput!) {
undoFinishTask(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UndoFinishTaskInput}
Response
{
"data": {
"undoFinishTask": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Task
}
}
}
unlinkFromDevice
Description
Unlink the Device from current user to stop receiving notifications
Response
Returns an UnlinkUserFromDevicePayload
Arguments
| Name | Description |
|---|---|
input - UnlinkUserFromDeviceInput!
|
Parameters for UnlinkUserFromDevice |
Example
Query
mutation unlinkFromDevice($input: UnlinkUserFromDeviceInput!) {
unlinkFromDevice(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result
}
}
Variables
{"input": UnlinkUserFromDeviceInput}
Response
{
"data": {
"unlinkFromDevice": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
}
}
unpinDocument
Response
Returns an UnpinDocumentPayload
Arguments
| Name | Description |
|---|---|
input - UnpinDocumentInput!
|
Parameters for UnpinDocument |
Example
Query
mutation unpinDocument($input: UnpinDocumentInput!) {
unpinDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UnpinDocumentInput}
Response
{
"data": {
"unpinDocument": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
}
}
unpinMessageBoard
Response
Returns an UnpinMessageBoardPayload
Arguments
| Name | Description |
|---|---|
input - UnpinMessageBoardInput!
|
Parameters for UnpinMessageBoard |
Example
Query
mutation unpinMessageBoard($input: UnpinMessageBoardInput!) {
unpinMessageBoard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
categories {
...MessageBoardCategoryFragment
}
createdAt
deletedAt
description
id
messageBoardsMembers {
...MessageBoardsMemberFragment
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UnpinMessageBoardInput}
Response
{
"data": {
"unpinMessageBoard": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoard
}
}
}
unpinMessageBoardPost
Response
Returns an UnpinMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - UnpinMessageBoardPostInput!
|
Parameters for UnpinMessageBoardPost |
Example
Query
mutation unpinMessageBoardPost($input: UnpinMessageBoardPostInput!) {
unpinMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": UnpinMessageBoardPostInput}
Response
{
"data": {
"unpinMessageBoardPost": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
updateAvailability
Response
Returns an UpdateAvailabilityPayload
Arguments
| Name | Description |
|---|---|
input - UpdateAvailabilityInput!
|
Parameters for UpdateAvailability |
Example
Query
mutation updateAvailability($input: UpdateAvailabilityInput!) {
updateAvailability(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
from
id
note
recurrence {
...RecurrenceFragment
}
timezone
to
type
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"input": UpdateAvailabilityInput}
Response
{
"data": {
"updateAvailability": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Availability
}
}
}
updateCalendarEvent
Response
Returns an UpdateCalendarEventPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCalendarEventInput!
|
Parameters for UpdateCalendarEvent |
Example
Query
mutation updateCalendarEvent($input: UpdateCalendarEventInput!) {
updateCalendarEvent(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
createdAt
creator {
...UserFragment
}
eventType
from
id
note
recurrence {
...RecurrenceFragment
}
schedules {
...ScheduleFragment
}
state
timezone
to
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateCalendarEventInput}
Response
{
"data": {
"updateCalendarEvent": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": CalendarEvent
}
}
}
updateChannel
Response
Returns an UpdateChannelPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelInput!
|
Parameters for UpdateChannel |
Example
Query
mutation updateChannel($input: UpdateChannelInput!) {
updateChannel(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateChannelInput}
Response
{
"data": {
"updateChannel": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatChannel
}
}
}
updateChannelMember
Response
Returns an UpdateChannelMemberPayload
Arguments
| Name | Description |
|---|---|
input - UpdateChannelMemberInput!
|
Parameters for UpdateChannelMember |
Example
Query
mutation updateChannelMember($input: UpdateChannelMemberInput!) {
updateChannelMember(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateChannelMemberInput}
Response
{
"data": {
"updateChannelMember": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChannelMember
}
}
}
updateComment
Response
Returns an UpdateCommentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCommentInput!
|
Parameters for UpdateComment |
Example
Query
mutation updateComment($input: UpdateCommentInput!) {
updateComment(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
author {
...UserFragment
}
commentableId
commentableType
content
createdAt
data {
...CommentDataEntryFragment
}
id
pinnedAt
reactions {
...ReactionFragment
}
systemGenerated
visibility
}
}
}
Variables
{"input": UpdateCommentInput}
Response
{
"data": {
"updateComment": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Comment
}
}
}
updateDocument
Response
Returns an UpdateDocumentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateDocumentInput!
|
Parameters for UpdateDocument |
Example
Query
mutation updateDocument($input: UpdateDocumentInput!) {
updateDocument(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
allUsersAssigned
archived
assignedGroups {
...GroupFragment
}
assignees {
...UserFragment
}
assignmentType
color
createdAt
creator {
...UserFragment
}
deletedAt
documentAttachments {
...DocumentAttachmentFragment
}
expiredAt
folder {
...FolderFragment
}
id
name
notes
pinnedAt
shareWithNewHires
state
tags {
...TagFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateDocumentInput}
Response
{
"data": {
"updateDocument": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
}
}
updateFolder
Response
Returns an UpdateFolderPayload
Arguments
| Name | Description |
|---|---|
input - UpdateFolderInput!
|
Parameters for UpdateFolder |
Example
Query
mutation updateFolder($input: UpdateFolderInput!) {
updateFolder(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
creator {
...UserFragment
}
deletedAt
description
documents {
...DocumentFragment
}
id
level
name
parent {
...FolderFragment
}
private
subFolders {
...FolderFragment
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateFolderInput}
Response
{
"data": {
"updateFolder": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Folder
}
}
}
updateGroup
Description
Update group (position) of the current workspace
Response
Returns an UpdateGroupPayload
Arguments
| Name | Description |
|---|---|
input - UpdateGroupInput!
|
Parameters for UpdateGroup |
Example
Query
mutation updateGroup($input: UpdateGroupInput!) {
updateGroup(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
}
}
Variables
{"input": UpdateGroupInput}
Response
{
"data": {
"updateGroup": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Group
}
}
}
updateJobSite
Response
Returns an UpdateJobSitePayload
Arguments
| Name | Description |
|---|---|
input - UpdateJobSiteInput!
|
Parameters for UpdateJobSite |
Example
Query
mutation updateJobSite($input: UpdateJobSiteInput!) {
updateJobSite(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
address
attachments {
...JobSiteAttachmentFragment
}
color
createdAt
geoLat
geoLong
id
name
note
payRate {
...JobSitePayRateFragment
}
schedules {
...ScheduleFragment
}
updatedAt
wifiBssid
wifiSsid
}
}
}
Variables
{"input": UpdateJobSiteInput}
Response
{
"data": {
"updateJobSite": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JobSite
}
}
}
updateJoinCode
Response
Returns an UpdateJoinCodePayload
Arguments
| Name | Description |
|---|---|
input - UpdateJoinCodeInput!
|
Parameters for UpdateJoinCode |
Example
Query
mutation updateJoinCode($input: UpdateJoinCodeInput!) {
updateJoinCode(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
code
effectiveUntil
id
requireApproval
}
}
}
Variables
{"input": UpdateJoinCodeInput}
Response
{
"data": {
"updateJoinCode": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JoinCode
}
}
}
updateLeave
Response
Returns an UpdateLeavePayload
Arguments
| Name | Description |
|---|---|
input - UpdateLeaveInput!
|
Parameters for UpdateLeave |
Example
Query
mutation updateLeave($input: UpdateLeaveInput!) {
updateLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateLeaveInput}
Response
{
"data": {
"updateLeave": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
updateLeaveCategories
Response
Returns an UpdateLeaveCategoriesPayload
Arguments
| Name | Description |
|---|---|
input - UpdateLeaveCategoriesInput!
|
Parameters for UpdateLeaveCategories |
Example
Query
mutation updateLeaveCategories($input: UpdateLeaveCategoriesInput!) {
updateLeaveCategories(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
enabled
id
name
paidLeave
unpaidLeave
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateLeaveCategoriesInput}
Response
{
"data": {
"updateLeaveCategories": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [LeaveCategory]
}
}
}
updateMembershipSettings
Response
Returns an UpdateMembershipSettingsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMembershipSettingsInput!
|
Parameters for UpdateMembershipSettings |
Example
Query
mutation updateMembershipSettings($input: UpdateMembershipSettingsInput!) {
updateMembershipSettings(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
emailLeaveRequest
emailManageAvailabilityRequest
emailManageDocument
emailManageLeaveRequest
emailManageMessageBoard
emailManageShiftOfferRequest
emailManageShiftSwapRequest
emailManageTimesheet
emailSchedulePosted
emailShiftOfferRequest
emailShiftReminder
emailShiftSwapRequest
emailSummary
emailTimesheet
id
maxDurationPerWeek
notificationShiftLate
typicalWorkDuration
}
}
}
Variables
{"input": UpdateMembershipSettingsInput}
Response
{
"data": {
"updateMembershipSettings": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MembershipSetting
}
}
}
updateMessageBoard
Response
Returns an UpdateMessageBoardPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMessageBoardInput!
|
Parameters for UpdateMessageBoard |
Example
Query
mutation updateMessageBoard($input: UpdateMessageBoardInput!) {
updateMessageBoard(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
categories {
...MessageBoardCategoryFragment
}
createdAt
deletedAt
description
id
messageBoardsMembers {
...MessageBoardsMemberFragment
}
name
pinnedAt
shareWithNewHires
unreadMessagesCount
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateMessageBoardInput}
Response
{
"data": {
"updateMessageBoard": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoard
}
}
}
updateMessageBoardPost
Response
Returns an UpdateMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMessageBoardPostInput!
|
Parameters for UpdateMessageBoardPost |
Example
Query
mutation updateMessageBoardPost($input: UpdateMessageBoardPostInput!) {
updateMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": UpdateMessageBoardPostInput}
Response
{
"data": {
"updateMessageBoardPost": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
updateReaction
Response
Returns an UpdateReactionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateReactionInput!
|
Parameters for UpdateReaction |
Example
Query
mutation updateReaction($input: UpdateReactionInput!) {
updateReaction(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
creator {
...UserFragment
}
emoji
id
reactable {
... on Comment {
...CommentFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
}
updatedAt
}
}
}
Variables
{"input": UpdateReactionInput}
Response
{
"data": {
"updateReaction": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Reaction
}
}
}
updateRole
Response
Returns an UpdateRolePayload
Arguments
| Name | Description |
|---|---|
input - UpdateRoleInput!
|
Parameters for UpdateRole |
Example
Query
mutation updateRole($input: UpdateRoleInput!) {
updateRole(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
code
description
id
name
rolesUsers {
...RolesUserFragment
}
}
}
}
Variables
{"input": UpdateRoleInput}
Response
{
"data": {
"updateRole": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Role
}
}
}
updateSchedule
Response
Returns an UpdateSchedulePayload
Arguments
| Name | Description |
|---|---|
input - UpdateScheduleInput!
|
Parameters for UpdateSchedule |
Example
Query
mutation updateSchedule($input: UpdateScheduleInput!) {
updateSchedule(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
createdAt
default
defaultJobSite {
...JobSiteFragment
}
id
name
schedulesUsers {
...ScheduleUserFragment
}
timezone
updatedAt
users {
...UserFragment
}
}
}
}
Variables
{"input": UpdateScheduleInput}
Response
{
"data": {
"updateSchedule": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Schedule
}
}
}
updateSchedulePhoto
Response
Returns an UpdateSchedulePhotoPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSchedulePhotoInput!
|
Parameters for UpdateSchedulePhoto |
Example
Query
mutation updateSchedulePhoto($input: UpdateSchedulePhotoInput!) {
updateSchedulePhoto(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
from
id
photo
schedule {
...ScheduleFragment
}
timezone
to
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateSchedulePhotoInput}
Response
{
"data": {
"updateSchedulePhoto": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": SchedulePhoto
}
}
}
updateShift
Response
Returns an UpdateShiftPayload
Arguments
| Name | Description |
|---|---|
input - UpdateShiftInput!
|
Parameters for UpdateShift |
Example
Query
mutation updateShift($input: UpdateShiftInput!) {
updateShift(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedTargetedShiftSwapRequests {
...ShiftSwapRequestFragment
}
assignee {
...UserFragment
}
attachments {
...ShiftAttachmentFragment
}
breakDuration
checklistAssignments {
...ChecklistAssignmentFragment
}
client {
...ClientFragment
}
color
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
note
recurrence {
...RecurrenceFragment
}
requester {
...UserFragment
}
requireClaimApproval
schedule {
...ScheduleFragment
}
shiftBatchId
shiftClaimRequests {
...ShiftClaimRequestFragment
}
shiftPartners {
...ShiftFragment
}
shiftRequests {
...ShiftRequestFragment
}
startTime
state
systemNote
timeCard {
...TimeCardFragment
}
timezone
title
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateShiftInput}
Response
{
"data": {
"updateShift": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
}
}
updateShiftBatch
Response
Returns an UpdateShiftBatchPayload
Arguments
| Name | Description |
|---|---|
input - UpdateShiftBatchInput!
|
Parameters for UpdateShiftBatch |
Example
Query
mutation updateShiftBatch($input: UpdateShiftBatchInput!) {
updateShiftBatch(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
id
requester {
...UserFragment
}
shifts {
...ShiftFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateShiftBatchInput}
Response
{
"data": {
"updateShiftBatch": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftBatch
}
}
}
updateShiftTemplate
Response
Returns an UpdateShiftTemplatePayload
Arguments
| Name | Description |
|---|---|
input - UpdateShiftTemplateInput!
|
Parameters for UpdateShiftTemplate |
Example
Query
mutation updateShiftTemplate($input: UpdateShiftTemplateInput!) {
updateShiftTemplate(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
breakDuration
endTime
endType
group {
...GroupFragment
}
id
jobSite {
...JobSiteFragment
}
name
note
schedule {
...ScheduleFragment
}
startTime
timezone
}
}
}
Variables
{"input": UpdateShiftTemplateInput}
Response
{
"data": {
"updateShiftTemplate": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftTemplate
}
}
}
updateTask
Response
Returns an UpdateTaskPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTaskInput!
|
Parameters for UpdateTask |
Example
Query
mutation updateTask($input: UpdateTaskInput!) {
updateTask(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
assignee {
...UserFragment
}
checklist {
...ChecklistFragment
}
code
comments {
...CommentFragment
}
completedLog {
...CompletedLogFragment
}
completionCountTarget
description
doneAt
dueDate
id
inProgressAt
lastCompletedAt
name
notStartedAt
parent {
...TaskFragment
}
requester {
...UserFragment
}
state
subTasks {
...TaskFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateTaskInput}
Response
{
"data": {
"updateTask": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Task
}
}
}
updateTimesheet
Response
Returns an UpdateTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTimesheetInput!
|
Parameters for UpdateTimesheet |
Example
Query
mutation updateTimesheet($input: UpdateTimesheetInput!) {
updateTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UpdateTimesheetInput}
Response
{
"data": {
"updateTimesheet": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
}
}
updateUser
Response
Returns an UpdateUserPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Parameters for UpdateUser |
Example
Query
mutation updateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
address
avatarUrl
birthday
dataState
email
firstName
groups {
...GroupFragment
}
id
kioskPinCode
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles
sampleUser
schedules {
...ScheduleFragment
}
state
updatedAt
}
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateUser": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": User
}
}
}
updateUserSettings
Response
Returns an UpdateUserSettingsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUserSettingsInput!
|
Parameters for UpdateUserSettings |
Example
Query
mutation updateUserSettings($input: UpdateUserSettingsInput!) {
updateUserSettings(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
address
avatarUrl
birthday
createdAt
email
firstName
id
kioskPinCode
language
lastName
membershipSettings {
...MembershipSettingFragment
}
name
phoneNumber
roles {
...RoleFragment
}
settings {
...UserSettingFragment
}
timezone
}
}
}
Variables
{"input": UpdateUserSettingsInput}
Response
{
"data": {
"updateUserSettings": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Whoami
}
}
}
updateWorkspace
Response
Returns an UpdateWorkspacePayload
Arguments
| Name | Description |
|---|---|
input - UpdateWorkspaceInput!
|
Parameters for UpdateWorkspace |
Example
Query
mutation updateWorkspace($input: UpdateWorkspaceInput!) {
updateWorkspace(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"input": UpdateWorkspaceInput}
Response
{
"data": {
"updateWorkspace": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Workspace
}
}
}
updateWorkspaceGroups
Description
Update groups (positions) of the current workspace
Response
Returns an UpdateWorkspaceGroupsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWorkspaceGroupsInput!
|
Parameters for UpdateWorkspaceGroups |
Example
Query
mutation updateWorkspaceGroups($input: UpdateWorkspaceGroupsInput!) {
updateWorkspaceGroups(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
color
colorName
createdAt
default
deletedAt
id
name
updatedAt
users {
...UserFragment
}
usersCount
}
}
}
Variables
{"input": UpdateWorkspaceGroupsInput}
Response
{
"data": {
"updateWorkspaceGroups": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Group]
}
}
}
updateWorkspaceSettings
Response
Returns an UpdateWorkspaceSettingsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateWorkspaceSettingsInput!
|
Parameters for UpdateWorkspaceSettings |
Example
Query
mutation updateWorkspaceSettings($input: UpdateWorkspaceSettingsInput!) {
updateWorkspaceSettings(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
createdAt
id
industry
logoUrl
metadata
meteredUsages {
...MeteredUsageFragment
}
name
settings {
...WorkspaceSettingFragment
}
size
timezone
}
}
}
Variables
{"input": UpdateWorkspaceSettingsInput}
Response
{
"data": {
"updateWorkspaceSettings": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Workspace
}
}
}
uploadSchedulePhoto
Description
Allow upload schedule photo
Response
Returns an UploadSchedulePhotoPayload
Arguments
| Name | Description |
|---|---|
input - UploadSchedulePhotoInput!
|
Parameters for UploadSchedulePhoto |
Example
Query
mutation uploadSchedulePhoto($input: UploadSchedulePhotoInput!) {
uploadSchedulePhoto(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
from
id
photo
schedule {
...ScheduleFragment
}
timezone
to
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": UploadSchedulePhotoInput}
Response
{
"data": {
"uploadSchedulePhoto": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [SchedulePhoto]
}
}
}
verifyJoinCode
Response
Returns a VerifyJoinCodePayload
Arguments
| Name | Description |
|---|---|
input - VerifyJoinCodeInput!
|
Parameters for VerifyJoinCode |
Example
Query
mutation verifyJoinCode($input: VerifyJoinCodeInput!) {
verifyJoinCode(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
requireApproval
users {
...UserFragment
}
workspaceId
workspaceName
}
}
}
Variables
{"input": VerifyJoinCodeInput}
Response
{
"data": {
"verifyJoinCode": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": VerifyJoinCodeResult
}
}
}
verifyKioskOtp
Response
Returns a VerifyKioskOtpPayload
Arguments
| Name | Description |
|---|---|
input - VerifyKioskOtpInput!
|
Parameters for VerifyKioskOtp |
Example
Query
mutation verifyKioskOtp($input: VerifyKioskOtpInput!) {
verifyKioskOtp(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
jwtToken
whoami {
...WhoamiFragment
}
workspaces {
...WorkspaceFragment
}
}
}
}
Variables
{"input": VerifyKioskOtpInput}
Response
{
"data": {
"verifyKioskOtp": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": KioskJwtPayload
}
}
}
verifyOtp
Response
Returns a VerifyOtpPayload
Arguments
| Name | Description |
|---|---|
input - VerifyOtpInput!
|
Parameters for VerifyOtp |
Example
Query
mutation verifyOtp($input: VerifyOtpInput!) {
verifyOtp(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
expiredAt
jwtToken
whoami {
...WhoamiFragment
}
workspaces {
...WorkspaceFragment
}
}
}
}
Variables
{"input": VerifyOtpInput}
Response
{
"data": {
"verifyOtp": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JwtPayload
}
}
}
viewMessageBoardPost
Response
Returns a ViewMessageBoardPostPayload
Arguments
| Name | Description |
|---|---|
input - ViewMessageBoardPostInput!
|
Parameters for ViewMessageBoardPost |
Example
Query
mutation viewMessageBoardPost($input: ViewMessageBoardPostInput!) {
viewMessageBoardPost(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
acknowledgementRequired
acknowledgements {
...AcknowledgementFragment
}
archivedAt
author {
...UserFragment
}
blocks
board {
...MessageBoardFragment
}
category {
...MessageBoardCategoryFragment
}
commentEnabled
commentsCount
confirmationRequiredUsers {
...UserFragment
}
createdAt
deletedAt
draftAt
id
images {
...MessageBoardPostImageFragment
}
messageBoardId
notifyUsers {
...UserFragment
}
pinnedAt
publishedAt
reactions {
...ReactionFragment
}
readAt
scheduledPostAt
state
title
updatedAt
}
}
}
Variables
{"input": ViewMessageBoardPostInput}
Response
{
"data": {
"viewMessageBoardPost": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
}
}
withdrawLeave
Response
Returns a WithdrawLeavePayload
Arguments
| Name | Description |
|---|---|
input - WithdrawLeaveInput!
|
Parameters for WithdrawLeave |
Example
Query
mutation withdrawLeave($input: WithdrawLeaveInput!) {
withdrawLeave(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
allDay
approvedAt
approver {
...UserFragment
}
approverId
canceledAt
days {
...LeaveRequestDayFragment
}
draftAt
employee {
...UserFragment
}
from
id
leaveCategory {
...LeaveCategoryFragment
}
paid
processedAt
reason
rejectedAt
requester {
...UserFragment
}
state
submittedAt
timezone
to
totalDuration
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": WithdrawLeaveInput}
Response
{
"data": {
"withdrawLeave": {
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveRequest
}
}
}
withdrawTimesheet
Response
Returns a WithdrawTimesheetPayload
Arguments
| Name | Description |
|---|---|
input - WithdrawTimesheetInput!
|
Parameters for WithdrawTimesheet |
Example
Query
mutation withdrawTimesheet($input: WithdrawTimesheetInput!) {
withdrawTimesheet(input: $input) {
clientMutationId
errors {
attribute
fullMessage
type
}
result {
approvedAt
approver {
...UserFragment
}
comments
creator {
...UserFragment
}
draftAt
employee {
...UserFragment
}
from
group {
...GroupFragment
}
id
processedAt
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
rejectedAt
schedule {
...ScheduleFragment
}
state
submittedAt
timezone
to
totalDuration
unpaidBreaks {
... on TimesheetAutoDeductBreak {
...TimesheetAutoDeductBreakFragment
}
... on TimesheetManualBreak {
...TimesheetManualBreakFragment
}
... on TimesheetPunchBreak {
...TimesheetPunchBreakFragment
}
}
updatedAt
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"input": WithdrawTimesheetInput}
Response
{
"data": {
"withdrawTimesheet": {
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
}
}
Subscriptions
channelMemberAdded
Description
Current user has been invited to the channel
Response
Returns a ChannelMemberAddedPayload!
Example
Query
subscription channelMemberAdded {
channelMemberAdded {
chatChannelMember {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Response
{
"data": {
"channelMemberAdded": {
"chatChannelMember": ChannelMember
}
}
}
channelMemberUpdated
Description
Used only to update the read messages count of inbox channel
Response
Returns a ChannelMemberUpdatedPayload!
Arguments
| Name | Description |
|---|---|
chatChannelMemberId - ID!
|
Example
Query
subscription channelMemberUpdated($chatChannelMemberId: ID!) {
channelMemberUpdated(chatChannelMemberId: $chatChannelMemberId) {
chatChannelMember {
chatChannel {
...ChatChannelFragment
}
id
lastViewedAt
lastViewedMessagesCount
mentionCount
notifyProps {
...ChannelMemberNotifyPropsFragment
}
role
user {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"chatChannelMemberId": "4"}
Response
{
"data": {
"channelMemberUpdated": {
"chatChannelMember": ChannelMember
}
}
}
channelUpdated
Description
Channel being updated
Response
Returns a ChannelUpdatedPayload!
Arguments
| Name | Description |
|---|---|
channelId - ID!
|
Example
Query
subscription channelUpdated($channelId: ID!) {
channelUpdated(channelId: $channelId) {
chatChannel {
archivedAt
channelType
chatMessagesCount
color
creator {
...UserFragment
}
currentMember {
...ChannelMemberFragment
}
displayName
emojiIcon
id
lastAddedMessageContent
lastMessageAt
members {
...ChannelMemberFragment
}
purpose
readOnly
suggested
users {
...UserFragment
}
workspace {
...WorkspaceFragment
}
}
}
}
Variables
{"channelId": "4"}
Response
{"data": {"channelUpdated": {"chatChannel": ChatChannel}}}
messageAdded
Description
A message was added
Response
Returns a MessageAddedPayload!
Arguments
| Name | Description |
|---|---|
channelId - ID!
|
Example
Query
subscription messageAdded($channelId: ID!) {
messageAdded(channelId: $channelId) {
message {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"channelId": 4}
Response
{"data": {"messageAdded": {"message": ChatMessage}}}
messageDeleted
Description
A message was deleted
Response
Returns a MessageDeletedPayload!
Arguments
| Name | Description |
|---|---|
channelId - ID!
|
Example
Query
subscription messageDeleted($channelId: ID!) {
messageDeleted(channelId: $channelId) {
message {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"channelId": 4}
Response
{"data": {"messageDeleted": {"message": ChatMessage}}}
messageUpdated
Description
A message was updated
Response
Returns a MessageUpdatedPayload!
Arguments
| Name | Description |
|---|---|
channelId - ID!
|
Example
Query
subscription messageUpdated($channelId: ID!) {
messageUpdated(channelId: $channelId) {
message {
blocks
chatAttachments {
...ChatAttachmentFragment
}
chatReactions {
...ChatReactionFragment
}
createdAt
deletedAt
id
message
pinned
read
updatedAt
user {
...UserFragment
}
}
}
}
Variables
{"channelId": 4}
Response
{"data": {"messageUpdated": {"message": ChatMessage}}}
notificationAdded
Description
A notification was added
Response
Returns a NotificationAddedPayload!
Arguments
| Name | Description |
|---|---|
userId - ID!
|
Example
Query
subscription notificationAdded($userId: ID!) {
notificationAdded(userId: $userId) {
notification {
actedUponAt
createdAt
id
message
notificationType
readAt
recipient {
...UserFragment
}
recipientId
referenceObject {
... on Document {
...DocumentFragment
}
... on LeaveRequest {
...LeaveRequestFragment
}
... on MessageBoardPost {
...MessageBoardPostFragment
}
... on Shift {
...ShiftFragment
}
... on ShiftClaimRequest {
...ShiftClaimRequestFragment
}
... on TimeCard {
...TimeCardFragment
}
}
sender {
...UserFragment
}
senderId
title
updatedAt
workspaceId
}
}
}
Variables
{"userId": "4"}
Response
{
"data": {
"notificationAdded": {"notification": Notification}
}
}
Types
AWS4Request
Example
{
"acl": "xyz789",
"key": "abc123",
"policy": "abc123",
"uri": "abc123",
"xAmzAlgorithm": "abc123",
"xAmzCredential": "abc123",
"xAmzDate": "abc123",
"xAmzSignature": "abc123"
}
Abilities
Fields
| Field Name | Description |
|---|---|
currentSubscriptions - [SubscriptionModel!]!
|
|
policyMatrix - [PolicyMatrixItem!]!
|
Returns the policy matrix for authorization |
roles - [Role!]!
|
|
rolesUsers - [RolesUser!]!
|
|
scheduleIds - [String!]
|
Example
{
"currentSubscriptions": [SubscriptionModel],
"policyMatrix": [PolicyMatrixItem],
"roles": [Role],
"rolesUsers": [RolesUser],
"scheduleIds": ["abc123"]
}
AcceptShiftOfferRequestInput
AcceptShiftOfferRequestPayload
Description
Autogenerated return type of AcceptShiftOfferRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftOfferRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftOfferRequest
}
AcceptShiftSwapRequestInput
AcceptShiftSwapRequestPayload
Description
Autogenerated return type of AcceptShiftSwapRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftSwapRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftSwapRequest
}
AcknowledgeDocumentInput
AcknowledgeDocumentPayload
Description
Autogenerated return type of AcknowledgeDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
Acknowledgeable
Description
Properties of Acknowledgeable
Types
| Union Types |
|---|
Example
Document
Acknowledgement
Fields
| Field Name | Description |
|---|---|
acknowledgeable - Acknowledgeable!
|
|
acknowledgedAt - ISO8601DateTime
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime!
|
|
id - ID!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"acknowledgeable": Document,
"acknowledgedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"id": "4",
"updatedAt": ISO8601DateTime,
"user": User
}
AnswerSurveyInput
Description
Autogenerated input type of AnswerSurvey
Fields
| Input Field | Description |
|---|---|
answers - [SurveyAnswerInput!]!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"answers": [SurveyAnswerInput],
"clientMutationId": "abc123"
}
AnswerSurveyPayload
Description
Autogenerated return type of AnswerSurvey
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
App
AppConnection
AppEdge
AppModuleEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ANNOUNCEMENT"
AppNotification
Fields
| Field Name | Description |
|---|---|
blocks - JSON
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
read - Boolean!
|
|
text - String
|
|
type - AppNotificationTypeEnum!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"blocks": {},
"createdAt": ISO8601DateTime,
"id": "4",
"read": false,
"text": "xyz789",
"type": "CAMELO_UPDATES",
"updatedAt": ISO8601DateTime
}
AppNotificationConnection
Description
The connection type for AppNotification.
Fields
| Field Name | Description |
|---|---|
edges - [AppNotificationEdge]
|
A list of edges. |
nodes - [AppNotification]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [AppNotificationEdge],
"nodes": [AppNotification],
"pageInfo": PageInfo,
"totalCount": 123
}
AppNotificationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - AppNotification
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": AppNotification
}
AppNotificationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CAMELO_UPDATES"
ApproveJoinRequestInput
ApproveJoinRequestPayload
Description
Autogenerated return type of ApproveJoinRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JoinRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JoinRequest
}
ApproveLeavesInput
ApproveLeavesPayload
Description
Autogenerated return type of ApproveLeaves
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [LeaveRequest!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [LeaveRequest]
}
ApproveShiftClaimRequestInput
ApproveShiftClaimRequestPayload
Description
Autogenerated return type of ApproveShiftClaimRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftClaimRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftClaimRequest
}
ApproveShiftOfferRequestInput
ApproveShiftOfferRequestPayload
Description
Autogenerated return type of ApproveShiftOfferRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftOfferRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftOfferRequest
}
ApproveShiftSwapRequestInput
ApproveShiftSwapRequestPayload
Description
Autogenerated return type of ApproveShiftSwapRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftSwapRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftSwapRequest
}
ApproveTimesheetsInput
ApproveTimesheetsPayload
Description
Autogenerated return type of ApproveTimesheets
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Timesheet!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Timesheet]
}
ArchiveChannelInput
ArchiveChannelPayload
Description
Autogenerated return type of ArchiveChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatChannel
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatChannel
}
ArchiveDocumentInput
ArchiveDocumentPayload
Description
Autogenerated return type of ArchiveDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
ArchiveMemberInput
ArchiveMemberPayload
Description
Autogenerated return type of ArchiveMember
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - String
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": "xyz789"
}
ArrivalStatusReportFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime!
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime!
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleIds": [4],
"toTime": ISO8601DateTime
}
ArrivalStatusResponse
AttendanceNotice
Fields
| Field Name | Description |
|---|---|
punch - TimeCardPunch!
|
|
user - User!
|
Example
{
"punch": TimeCardPunch,
"user": User
}
AttendanceNoticesReportFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime!
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime!
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleIds": [4],
"toTime": ISO8601DateTime
}
AuthenticationMethod
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EMAIL"
Availability
Fields
| Field Name | Description |
|---|---|
allDay - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
from - ISO8601DateTime!
|
|
id - ID!
|
|
note - String
|
|
recurrence - Recurrence
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
|
type - AvailabilityTypeEnum!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"allDay": false,
"createdAt": ISO8601DateTime,
"from": ISO8601DateTime,
"id": 4,
"note": "abc123",
"recurrence": Recurrence,
"timezone": "xyz789",
"to": ISO8601DateTime,
"type": "PREFERRED_WORKING_TIME",
"updatedAt": ISO8601DateTime,
"user": User
}
AvailabilityConnection
Description
The connection type for Availability.
Fields
| Field Name | Description |
|---|---|
edges - [AvailabilityEdge]
|
A list of edges. |
nodes - [Availability]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [AvailabilityEdge],
"nodes": [Availability],
"pageInfo": PageInfo,
"totalCount": 987
}
AvailabilityEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Availability
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": Availability
}
AvailabilityFilter
Fields
| Input Field | Description |
|---|---|
_or - [AvailabilityFilter!]
|
|
employeeIds - [ID!]
|
|
fromTime - ISO8601DateTime
|
|
original - Boolean!
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime
|
|
type - AvailabilityTypeEnum
|
Example
{
"_or": [AvailabilityFilter],
"employeeIds": [4],
"fromTime": ISO8601DateTime,
"original": false,
"scheduleIds": ["4"],
"toTime": ISO8601DateTime,
"type": "PREFERRED_WORKING_TIME"
}
AvailabilityTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PREFERRED_WORKING_TIME"
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BulkRejectTimesheetsInput
BulkRejectTimesheetsPayload
Description
Autogenerated return type of BulkRejectTimesheets
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Timesheet!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Timesheet]
}
CalendarEvent
Fields
| Field Name | Description |
|---|---|
allDay - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
eventType - CalendarEventTypeEnum!
|
|
from - ISO8601DateTime!
|
|
id - ID!
|
|
note - String
|
|
recurrence - Recurrence
|
|
schedules - [Schedule!]
|
|
state - CalendarEventStateEnum!
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"allDay": false,
"createdAt": ISO8601DateTime,
"creator": User,
"eventType": "CLOSED_BUSINESS",
"from": ISO8601DateTime,
"id": 4,
"note": "xyz789",
"recurrence": Recurrence,
"schedules": [Schedule],
"state": "ACTIVE",
"timezone": "xyz789",
"to": ISO8601DateTime,
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
CalendarEventConnection
Description
The connection type for CalendarEvent.
Fields
| Field Name | Description |
|---|---|
edges - [CalendarEventEdge]
|
A list of edges. |
nodes - [CalendarEvent]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [CalendarEventEdge],
"nodes": [CalendarEvent],
"pageInfo": PageInfo,
"totalCount": 123
}
CalendarEventEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - CalendarEvent
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": CalendarEvent
}
CalendarEventFilter
Fields
| Input Field | Description |
|---|---|
_or - [CalendarEventFilter!]
|
|
eventType - CalendarEventTypeEnum
|
|
fromTime - ISO8601DateTime
|
|
scheduleIds - [ID!]
|
|
states - [CalendarEventStateEnum!]
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [CalendarEventFilter],
"eventType": "CLOSED_BUSINESS",
"fromTime": ISO8601DateTime,
"scheduleIds": [4],
"states": ["ACTIVE"],
"toTime": ISO8601DateTime
}
CalendarEventInput
Fields
| Input Field | Description |
|---|---|
allDay - Boolean!
|
|
eventType - CalendarEventTypeEnum
|
|
from - ISO8601DateTime!
|
|
note - String
|
|
recurrenceRule - String
|
|
scheduleIds - [ID!]
|
|
state - CalendarEventStateEnum
|
|
timezone - String
|
|
to - ISO8601DateTime!
|
Example
{
"allDay": false,
"eventType": "CLOSED_BUSINESS",
"from": ISO8601DateTime,
"note": "xyz789",
"recurrenceRule": "xyz789",
"scheduleIds": ["4"],
"state": "ACTIVE",
"timezone": "abc123",
"to": ISO8601DateTime
}
CalendarEventStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
CalendarEventTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLOSED_BUSINESS"
CancelLeaveInput
CancelLeavePayload
Description
Autogenerated return type of CancelLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
CancelShiftClaimRequestInput
CancelShiftClaimRequestPayload
Description
Autogenerated return type of CancelShiftClaimRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftClaimRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftClaimRequest
}
CancelShiftOfferInput
CancelShiftOfferPayload
Description
Autogenerated return type of CancelShiftOffer
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftOffer
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftOffer
}
CancelShiftSwapInput
CancelShiftSwapPayload
Description
Autogenerated return type of CancelShiftSwap
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftSwap
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftSwap
}
ChannelFilter
Fields
| Input Field | Description |
|---|---|
_or - [ChannelFilter!]
|
|
archived - Boolean
|
|
channelType - ChannelTypeEnum
|
|
joined - Boolean!
|
List joined channels only |
nameContains - String
|
Example
{
"_or": [ChannelFilter],
"archived": true,
"channelType": "DIRECT",
"joined": true,
"nameContains": "xyz789"
}
ChannelMember
Fields
| Field Name | Description |
|---|---|
chatChannel - ChatChannel!
|
|
id - ID!
|
|
lastViewedAt - ISO8601DateTime!
|
|
lastViewedMessagesCount - Int!
|
|
mentionCount - Int!
|
|
notifyProps - ChannelMemberNotifyProps
|
|
role - ChannelMemberRoleEnum!
|
|
user - User!
|
|
workspace - Workspace!
|
Example
{
"chatChannel": ChatChannel,
"id": "4",
"lastViewedAt": ISO8601DateTime,
"lastViewedMessagesCount": 123,
"mentionCount": 987,
"notifyProps": ChannelMemberNotifyProps,
"role": "ADMIN",
"user": User,
"workspace": Workspace
}
ChannelMemberAddedPayload
Description
Autogenerated return type of ChannelMemberAdded
Fields
| Field Name | Description |
|---|---|
chatChannelMember - ChannelMember!
|
Example
{"chatChannelMember": ChannelMember}
ChannelMemberNotificationEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ChannelMemberNotifyProps
Fields
| Field Name | Description |
|---|---|
muted - Boolean!
|
|
notification - ChannelMemberNotificationEnum!
|
Example
{"muted": false, "notification": "ALL"}
ChannelMemberRoleEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
ChannelMemberUpdatedPayload
Description
Autogenerated return type of ChannelMemberUpdated
Fields
| Field Name | Description |
|---|---|
chatChannelMember - ChannelMember!
|
Example
{"chatChannelMember": ChannelMember}
ChannelTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DIRECT"
ChannelUpdatedPayload
Description
Autogenerated return type of ChannelUpdated
Fields
| Field Name | Description |
|---|---|
chatChannel - ChatChannel!
|
Example
{"chatChannel": ChatChannel}
ChatAttachment
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
metadata - ChatAttachmentMetadata
|
|
thumbUrl - String
|
|
type - ChatAttachmentEnum!
|
|
updatedAt - ISO8601DateTime!
|
|
url - String!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"metadata": ChatAttachmentMetadata,
"thumbUrl": "abc123",
"type": "DOCUMENT",
"updatedAt": ISO8601DateTime,
"url": "xyz789"
}
ChatAttachmentEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DOCUMENT"
ChatAttachmentMetadata
ChatAttachmentMetadataInput
ChatChannel
Fields
| Field Name | Description |
|---|---|
archivedAt - ISO8601DateTime
|
|
channelType - ChannelTypeEnum!
|
|
chatMessagesCount - Int!
|
|
color - String
|
|
creator - User!
|
|
currentMember - ChannelMember
|
|
displayName - String!
|
|
emojiIcon - String
|
|
id - ID!
|
|
lastAddedMessageContent - String
|
|
lastMessageAt - ISO8601DateTime
|
|
members - [ChannelMember!]
|
|
Arguments
|
|
purpose - String
|
|
readOnly - Boolean!
|
|
suggested - Boolean!
|
|
users - [User!]
|
Use :members instead. From 1.1.19 |
workspace - Workspace!
|
|
Example
{
"archivedAt": ISO8601DateTime,
"channelType": "DIRECT",
"chatMessagesCount": 123,
"color": "xyz789",
"creator": User,
"currentMember": ChannelMember,
"displayName": "xyz789",
"emojiIcon": "xyz789",
"id": 4,
"lastAddedMessageContent": "xyz789",
"lastMessageAt": ISO8601DateTime,
"members": [ChannelMember],
"purpose": "xyz789",
"readOnly": true,
"suggested": true,
"users": [User],
"workspace": Workspace
}
ChatChannelConnection
Description
The connection type for ChatChannel.
Fields
| Field Name | Description |
|---|---|
edges - [ChatChannelEdge]
|
A list of edges. |
nodes - [ChatChannel]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [ChatChannelEdge],
"nodes": [ChatChannel],
"pageInfo": PageInfo,
"totalCount": 123
}
ChatChannelEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ChatChannel
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ChatChannel
}
ChatMessage
Fields
| Field Name | Description |
|---|---|
blocks - JSON
|
|
chatAttachments - [ChatAttachment!]!
|
|
chatReactions - [ChatReaction!]!
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
id - ID!
|
|
message - String
|
|
pinned - Boolean
|
|
read - Boolean!
|
Used for inbox only |
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"blocks": {},
"chatAttachments": [ChatAttachment],
"chatReactions": [ChatReaction],
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"id": 4,
"message": "abc123",
"pinned": false,
"read": true,
"updatedAt": ISO8601DateTime,
"user": User
}
ChatMessageConnection
Description
The connection type for ChatMessage.
Fields
| Field Name | Description |
|---|---|
edges - [ChatMessageEdge]
|
A list of edges. |
nodes - [ChatMessage]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [ChatMessageEdge],
"nodes": [ChatMessage],
"pageInfo": PageInfo,
"totalCount": 987
}
ChatMessageEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ChatMessage
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ChatMessage
}
ChatReaction
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
emoji - String!
|
|
id - ID!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"createdAt": ISO8601DateTime,
"emoji": "abc123",
"id": "4",
"updatedAt": ISO8601DateTime,
"user": User
}
Checklist
ChecklistAssignable
ChecklistAssignment
Fields
| Field Name | Description |
|---|---|
assignable - ChecklistAssignable!
|
|
checklist - Checklist!
|
|
collaborationMode - CollaborationModeEnum
|
|
completionPercentage - Int!
|
|
date - ISO8601DateTime
|
|
id - ID!
|
|
recurrence - Recurrence!
|
Example
{
"assignable": Group,
"checklist": Checklist,
"collaborationMode": "COLLABORATIVE",
"completionPercentage": 123,
"date": ISO8601DateTime,
"id": "4",
"recurrence": Recurrence
}
ChecklistAssignmentAssignableTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GROUP"
ChecklistAssignmentFilter
Fields
| Input Field | Description |
|---|---|
_or - [ChecklistAssignmentFilter!]
|
|
assignableId - String
|
|
assignableType - ChecklistAssignmentAssignableTypeEnum
|
|
assigneeIds - [ID!]
|
|
fromTime - ISO8601DateTime
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [ChecklistAssignmentFilter],
"assignableId": "xyz789",
"assignableType": "GROUP",
"assigneeIds": [4],
"fromTime": ISO8601DateTime,
"toTime": ISO8601DateTime
}
ChecklistFilter
Fields
| Input Field | Description |
|---|---|
_or - [ChecklistFilter!]
|
|
creatorIds - [ID!]
|
|
template - Boolean
|
Example
{
"_or": [ChecklistFilter],
"creatorIds": [4],
"template": true
}
ClaimShiftInput
ClaimShiftPayload
Description
Autogenerated return type of ClaimShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
Client
Fields
| Field Name | Description |
|---|---|
clientNumber - String
|
|
createdAt - ISO8601DateTime!
|
|
email - String
|
|
id - ID!
|
|
name - String!
|
|
phoneNumber - String
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"clientNumber": "xyz789",
"createdAt": ISO8601DateTime,
"email": "abc123",
"id": "4",
"name": "abc123",
"phoneNumber": "xyz789",
"updatedAt": ISO8601DateTime
}
CollaborationModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COLLABORATIVE"
Comment
Fields
| Field Name | Description |
|---|---|
author - User!
|
|
commentableId - ID!
|
|
commentableType - CommentableTypeEnum!
|
|
content - String!
|
|
createdAt - ISO8601DateTime!
|
|
data - [CommentDataEntry!]
|
|
id - ID!
|
|
pinnedAt - ISO8601DateTime
|
|
reactions - [Reaction!]
|
|
systemGenerated - Boolean!
|
|
visibility - VisibilityEnum!
|
Example
{
"author": User,
"commentableId": 4,
"commentableType": "CLIENT",
"content": "abc123",
"createdAt": ISO8601DateTime,
"data": [CommentDataEntry],
"id": 4,
"pinnedAt": ISO8601DateTime,
"reactions": [Reaction],
"systemGenerated": false,
"visibility": "PRIVATE"
}
CommentConnection
Description
The connection type for Comment.
Fields
| Field Name | Description |
|---|---|
edges - [CommentEdge]
|
A list of edges. |
nodes - [Comment]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [CommentEdge],
"nodes": [Comment],
"pageInfo": PageInfo,
"totalCount": 987
}
CommentDataEntry
CommentEdge
CommentableTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLIENT"
CompletedLog
Fields
| Field Name | Description |
|---|---|
at - ISO8601DateTime!
|
|
by - User
|
|
type - CompletedLogTypeEnum!
|
Example
{
"at": ISO8601DateTime,
"by": User,
"type": "FINISH"
}
CompletedLogTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FINISH"
ConfirmMessageBoardPostInput
ConfirmMessageBoardPostPayload
Description
Autogenerated return type of ConfirmMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
ConfirmShiftInput
ConfirmShiftPayload
Description
Autogenerated return type of ConfirmShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
ConfirmShiftsInput
ConfirmShiftsPayload
Description
Autogenerated return type of ConfirmShifts
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Shift!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Shift]
}
CopyShiftsInput
Description
Autogenerated input type of CopyShifts
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
fromWeek - ISO8601DateTime
|
Start date of the week to copy from |
scheduleId - ID
|
ID of the schedule to copy from |
states - [ShiftStateEnum!]
|
States to filter copy shifts |
toWeek - ISO8601DateTime!
|
Start date of the week to copy to |
Example
{
"clientMutationId": "abc123",
"fromWeek": ISO8601DateTime,
"scheduleId": 4,
"states": ["ABSENT"],
"toWeek": ISO8601DateTime
}
CopyShiftsPayload
Description
Autogenerated return type of CopyShifts
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": false
}
CreateAvailabilityInput
Description
Autogenerated input type of CreateAvailability
Fields
| Input Field | Description |
|---|---|
allDay - Boolean!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
from - ISO8601DateTime!
|
|
note - String
|
|
recurrenceRule - String
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
|
type - AvailabilityTypeEnum!
|
|
userId - ID
|
Example
{
"allDay": true,
"clientMutationId": "xyz789",
"from": ISO8601DateTime,
"note": "abc123",
"recurrenceRule": "xyz789",
"timezone": "xyz789",
"to": ISO8601DateTime,
"type": "PREFERRED_WORKING_TIME",
"userId": "4"
}
CreateAvailabilityPayload
Description
Autogenerated return type of CreateAvailability
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Availability
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Availability
}
CreateCalendarEventInput
Description
Autogenerated input type of CreateCalendarEvent
Fields
| Input Field | Description |
|---|---|
allDay - Boolean!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventType - CalendarEventTypeEnum
|
|
from - ISO8601DateTime!
|
|
note - String
|
|
recurrenceRule - String
|
|
scheduleIds - [ID!]
|
|
state - CalendarEventStateEnum
|
|
timezone - String
|
|
to - ISO8601DateTime!
|
Example
{
"allDay": false,
"clientMutationId": "xyz789",
"eventType": "CLOSED_BUSINESS",
"from": ISO8601DateTime,
"note": "xyz789",
"recurrenceRule": "xyz789",
"scheduleIds": [4],
"state": "ACTIVE",
"timezone": "abc123",
"to": ISO8601DateTime
}
CreateCalendarEventPayload
Description
Autogenerated return type of CreateCalendarEvent
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - CalendarEvent
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": CalendarEvent
}
CreateCalendarEventsInput
Description
Autogenerated input type of CreateCalendarEvents
Fields
| Input Field | Description |
|---|---|
calendarEventsInput - [CalendarEventInput!]!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"calendarEventsInput": [CalendarEventInput],
"clientMutationId": "xyz789"
}
CreateCalendarEventsPayload
Description
Autogenerated return type of CreateCalendarEvents
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [CalendarEvent!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [CalendarEvent]
}
CreateChannelInput
Description
Autogenerated input type of CreateChannel
Example
{
"channelType": "DIRECT",
"clientMutationId": "abc123",
"color": "xyz789",
"displayName": "abc123",
"emojiIcon": "abc123",
"memberIds": ["4"],
"purpose": "abc123",
"sticky": true
}
CreateChannelPayload
Description
Autogenerated return type of CreateChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatChannel
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatChannel
}
CreateChecklistInput
Description
Autogenerated input type of CreateChecklist
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
name - String!
|
|
tasks - [CreateChecklistTaskInput!]
|
|
template - Boolean
|
Example
{
"clientMutationId": "xyz789",
"name": "abc123",
"tasks": [CreateChecklistTaskInput],
"template": true
}
CreateChecklistPayload
Description
Autogenerated return type of CreateChecklist
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Checklist
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Checklist
}
CreateChecklistTaskInput
Fields
| Input Field | Description |
|---|---|
code - String
|
|
completionCountTarget - Int
|
|
description - String
|
|
name - String!
|
|
subTasks - [CreateChecklistTaskInput!]
|
Example
{
"code": "abc123",
"completionCountTarget": 123,
"description": "abc123",
"name": "abc123",
"subTasks": [CreateChecklistTaskInput]
}
CreateCheckoutSessionInput
CreateCheckoutSessionPayload
Description
Autogenerated return type of CreateCheckoutSession
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - String
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": "xyz789"
}
CreateCommentInput
Description
Autogenerated input type of CreateComment
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
commentableId - ID!
|
|
commentableType - CommentableTypeEnum!
|
|
content - String!
|
Example
{
"clientMutationId": "abc123",
"commentableId": "4",
"commentableType": "CLIENT",
"content": "abc123"
}
CreateCommentPayload
Description
Autogenerated return type of CreateComment
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Comment
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Comment
}
CreateDocumentInput
Description
Autogenerated input type of CreateDocument
Fields
| Input Field | Description |
|---|---|
acknowledgementRequired - Boolean
|
|
allUsersAssigned - Boolean
|
|
assignedGroupIds - [ID!]
|
|
assigneeIds - [ID!]
|
|
assignmentType - DocumentAssignmentEnum
|
|
attachments - [DocumentAttachmentInput!]!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
expiredAt - ISO8601DateTime
|
|
folderId - ID
|
|
name - String!
|
|
notes - String
|
|
saveAsDraft - Boolean
|
|
shareWithNewHires - Boolean
|
|
tags - [TagInput!]
|
Example
{
"acknowledgementRequired": true,
"allUsersAssigned": true,
"assignedGroupIds": [4],
"assigneeIds": ["4"],
"assignmentType": "PERSONAL",
"attachments": [DocumentAttachmentInput],
"clientMutationId": "xyz789",
"color": "abc123",
"expiredAt": ISO8601DateTime,
"folderId": 4,
"name": "abc123",
"notes": "abc123",
"saveAsDraft": true,
"shareWithNewHires": false,
"tags": [TagInput]
}
CreateDocumentPayload
Description
Autogenerated return type of CreateDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
CreateFeedbackInput
CreateFeedbackPayload
Description
Autogenerated return type of CreateFeedback
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
CreateFolderInput
Description
Autogenerated input type of CreateFolder
Example
{
"clientMutationId": "abc123",
"description": "xyz789",
"documentIds": ["4"],
"name": "abc123",
"parentId": "4",
"private": false
}
CreateFolderPayload
Description
Autogenerated return type of CreateFolder
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Folder
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Folder
}
CreateGroupsInput
Description
Autogenerated input type of CreateGroups
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
groupsInput - [GroupInput!]!
|
Example
{
"clientMutationId": "abc123",
"groupsInput": [GroupInput]
}
CreateGroupsPayload
Description
Autogenerated return type of CreateGroups
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Group!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Group]
}
CreateJobSiteInput
Description
Autogenerated input type of CreateJobSite
Fields
| Input Field | Description |
|---|---|
address - String!
|
|
attachments - [JobSiteAttachmentInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
geoLat - Float!
|
|
geoLong - Float!
|
|
name - String!
|
|
note - String
|
|
payRate - JobSitePayRateInput
|
|
scheduleIds - [ID!]!
|
|
wifiBssid - String
|
|
wifiSsid - String
|
Example
{
"address": "abc123",
"attachments": [JobSiteAttachmentInput],
"clientMutationId": "xyz789",
"color": "xyz789",
"geoLat": 123.45,
"geoLong": 123.45,
"name": "abc123",
"note": "abc123",
"payRate": JobSitePayRateInput,
"scheduleIds": [4],
"wifiBssid": "xyz789",
"wifiSsid": "abc123"
}
CreateJobSitePayload
Description
Autogenerated return type of CreateJobSite
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JobSite
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JobSite
}
CreateJoinCodeInput
CreateJoinCodePayload
Description
Autogenerated return type of CreateJoinCode
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JoinCode
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JoinCode
}
CreateJoinRequestInput
Description
Autogenerated input type of CreateJoinRequest
Example
{
"clientMutationId": "xyz789",
"email": "abc123",
"firstName": "abc123",
"joinCode": "xyz789",
"lastName": "abc123",
"phoneNumber": "abc123",
"timezone": "abc123",
"userId": 4,
"workspaceId": "4"
}
CreateJoinRequestPayload
Description
Autogenerated return type of CreateJoinRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JoinRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JoinRequest
}
CreateLeaveCategoryInput
Description
Autogenerated input type of CreateLeaveCategory
Example
{
"clientMutationId": "abc123",
"name": "xyz789",
"paidLeave": false,
"unpaidLeave": false
}
CreateLeaveCategoryPayload
Description
Autogenerated return type of CreateLeaveCategory
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveCategory
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveCategory
}
CreateMessageBoardInput
Description
Autogenerated input type of CreateMessageBoard
Example
{
"allUsersAccessed": false,
"clientMutationId": "xyz789",
"description": "abc123",
"memberIds": [4],
"name": "xyz789",
"shareWithNewHires": true
}
CreateMessageBoardPayload
Description
Autogenerated return type of CreateMessageBoard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoard
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoard
}
CreateMessageBoardPostInput
Description
Autogenerated input type of CreateMessageBoardPost
Fields
| Input Field | Description |
|---|---|
acknowledgementRequired - Boolean
|
|
blocks - JSON
|
|
categoryId - ID
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
commentEnabled - Boolean
|
|
content - String
|
|
images - [MessageBoardPostImageInput!]
|
|
messageBoardId - ID!
|
|
notifyAllMembers - Boolean
|
|
notifyUserIds - [ID!]
|
|
pinnedAt - ISO8601DateTime
|
|
saveAsDraft - Boolean
|
|
scheduledPostAt - ISO8601DateTime
|
|
title - String!
|
Example
{
"acknowledgementRequired": true,
"blocks": {},
"categoryId": 4,
"clientMutationId": "abc123",
"commentEnabled": false,
"content": "abc123",
"images": [MessageBoardPostImageInput],
"messageBoardId": "4",
"notifyAllMembers": true,
"notifyUserIds": ["4"],
"pinnedAt": ISO8601DateTime,
"saveAsDraft": false,
"scheduledPostAt": ISO8601DateTime,
"title": "xyz789"
}
CreateMessageBoardPostPayload
Description
Autogenerated return type of CreateMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
CreateMessageInput
Description
Autogenerated input type of CreateMessage
Fields
| Input Field | Description |
|---|---|
attachments - [MessageAttachmentInput!]
|
|
channelId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
message - String!
|
Example
{
"attachments": [MessageAttachmentInput],
"channelId": "4",
"clientMutationId": "xyz789",
"message": "abc123"
}
CreateMessagePayload
Description
Autogenerated return type of CreateMessage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatMessage
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatMessage
}
CreateReactionInput
Description
Autogenerated input type of CreateReaction
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
emoji - String!
|
|
reactableId - ID!
|
|
reactableType - ReactableTypeEnum!
|
Example
{
"clientMutationId": "abc123",
"emoji": "abc123",
"reactableId": "4",
"reactableType": "COMMENT"
}
CreateReactionPayload
Description
Autogenerated return type of CreateReaction
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Reaction
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Reaction
}
CreateScheduleInput
Description
Autogenerated input type of CreateSchedule
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
defaultJobSiteId - ID
|
|
name - String!
|
|
schedulesUsers - [SchedulesUserInput!]
|
|
timezone - String
|
Example
{
"clientMutationId": "xyz789",
"defaultJobSiteId": "4",
"name": "xyz789",
"schedulesUsers": [SchedulesUserInput],
"timezone": "xyz789"
}
CreateSchedulePayload
Description
Autogenerated return type of CreateSchedule
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Schedule
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Schedule
}
CreateShiftBatchInput
Description
Autogenerated input type of CreateShiftBatch
Fields
| Input Field | Description |
|---|---|
assignees - [ShiftBatchAssigneeInput!]!
|
|
attachments - [ShiftAttachmentInput!]
|
|
breakDuration - Minute!
|
|
checklists - [CreateShiftChecklistInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime!
|
|
endType - ShiftEndTypeInputEnum
|
|
jobSiteId - ID
|
|
note - String
|
|
recurrenceRule - String
|
|
saveAsTemplate - Boolean
|
|
scheduleId - ID!
|
|
startTime - ISO8601DateTime!
|
|
timezone - String!
|
|
title - String
|
Example
{
"assignees": [ShiftBatchAssigneeInput],
"attachments": [ShiftAttachmentInput],
"breakDuration": Minute,
"checklists": [CreateShiftChecklistInput],
"clientMutationId": "abc123",
"color": "abc123",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"jobSiteId": "4",
"note": "xyz789",
"recurrenceRule": "abc123",
"saveAsTemplate": false,
"scheduleId": "4",
"startTime": ISO8601DateTime,
"timezone": "abc123",
"title": "abc123"
}
CreateShiftBatchPayload
Description
Autogenerated return type of CreateShiftBatch
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftBatch
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftBatch
}
CreateShiftChecklistInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
tasks - [CreateShiftTaskInput!]
|
Example
{
"name": "abc123",
"tasks": [CreateShiftTaskInput]
}
CreateShiftInput
Description
Autogenerated input type of CreateShift
Fields
| Input Field | Description |
|---|---|
addGroupToAssignee - Boolean
|
|
assigneeId - ID
|
|
attachments - [ShiftAttachmentInput!]
|
|
breakDuration - Minute!
|
|
checklists - [CreateShiftChecklistInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime!
|
|
endType - ShiftEndTypeInputEnum
|
|
groupId - ID
|
|
jobSiteId - ID
|
|
note - String
|
|
numOfCopies - Int
|
|
recurrenceRule - String
|
|
requireClaimApproval - Boolean
|
|
saveAsTemplate - Boolean
|
|
scheduleId - ID!
|
|
startTime - ISO8601DateTime!
|
|
timezone - String!
|
|
title - String
|
Example
{
"addGroupToAssignee": false,
"assigneeId": 4,
"attachments": [ShiftAttachmentInput],
"breakDuration": Minute,
"checklists": [CreateShiftChecklistInput],
"clientMutationId": "xyz789",
"color": "xyz789",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"groupId": "4",
"jobSiteId": 4,
"note": "xyz789",
"numOfCopies": 987,
"recurrenceRule": "abc123",
"requireClaimApproval": true,
"saveAsTemplate": false,
"scheduleId": "4",
"startTime": ISO8601DateTime,
"timezone": "abc123",
"title": "xyz789"
}
CreateShiftPayload
Description
Autogenerated return type of CreateShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
CreateShiftTaskInput
Fields
| Input Field | Description |
|---|---|
code - String
|
|
completionCountTarget - Int
|
|
description - String
|
|
dueDate - ISO8601DateTime
|
|
name - String!
|
|
subTasks - [CreateShiftTaskInput!]
|
Example
{
"code": "abc123",
"completionCountTarget": 987,
"description": "abc123",
"dueDate": ISO8601DateTime,
"name": "xyz789",
"subTasks": [CreateShiftTaskInput]
}
CreateShiftTemplateInput
Description
Autogenerated input type of CreateShiftTemplate
Fields
| Input Field | Description |
|---|---|
breakDuration - Minute
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime!
|
|
endType - ShiftEndTypeInputEnum
|
|
groupId - ID
|
|
jobSiteId - ID
|
|
name - String
|
|
note - String
|
|
scheduleId - ID!
|
|
startTime - ISO8601DateTime!
|
|
timezone - String
|
Example
{
"breakDuration": Minute,
"clientMutationId": "abc123",
"color": "abc123",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"groupId": 4,
"jobSiteId": "4",
"name": "xyz789",
"note": "xyz789",
"scheduleId": "4",
"startTime": ISO8601DateTime,
"timezone": "abc123"
}
CreateShiftTemplatePayload
Description
Autogenerated return type of CreateShiftTemplate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftTemplate
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftTemplate
}
CreateTagInput
CreateTagPayload
Description
Autogenerated return type of CreateTag
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Tag
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Tag
}
CreateTaskInput
Description
Autogenerated input type of CreateTask
Fields
| Input Field | Description |
|---|---|
assigneeId - ID
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
description - String!
|
|
dueDate - ISO8601DateTime
|
|
name - String!
|
Example
{
"assigneeId": "4",
"clientMutationId": "abc123",
"description": "xyz789",
"dueDate": ISO8601DateTime,
"name": "xyz789"
}
CreateTaskPayload
Description
Autogenerated return type of CreateTask
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Task
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Task
}
CreateTimeCardInput
Description
Autogenerated input type of CreateTimeCard
Example
{
"clientMutationId": "abc123",
"groupId": "4",
"note": "xyz789",
"scheduleId": "4",
"timezone": "xyz789"
}
CreateTimeCardPayload
Description
Autogenerated return type of CreateTimeCard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - TimeCard
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": TimeCard
}
CreateUsersInput
Description
Autogenerated input type of CreateUsers
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
usersInput - [UserInput!]!
|
Example
{
"clientMutationId": "xyz789",
"usersInput": [UserInput]
}
CreateUsersPayload
Description
Autogenerated return type of CreateUsers
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [User!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [User]
}
CreateWorkspaceSampleDataInput
Description
Autogenerated input type of CreateWorkspaceSampleData
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{"clientMutationId": "abc123"}
CreateWorkspaceSampleDataPayload
Description
Autogenerated return type of CreateWorkspaceSampleData
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": false
}
Dashboard
DashboardOverviewFilter
Fields
| Input Field | Description |
|---|---|
_or - [DashboardOverviewFilter!]
|
|
fromTime - ISO8601DateTime!
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime!
|
Example
{
"_or": [DashboardOverviewFilter],
"fromTime": ISO8601DateTime,
"scheduleIds": ["4"],
"toTime": ISO8601DateTime
}
DeleteFilesInput
Description
Autogenerated input type of DeleteFiles
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
keys - [String!]!
|
Example
{
"clientMutationId": "xyz789",
"keys": ["xyz789"]
}
DeleteFilesPayload
Description
Autogenerated return type of DeleteFiles
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": true
}
DestroyAvailabilityInput
Description
Autogenerated input type of DestroyAvailability
Fields
| Input Field | Description |
|---|---|
availabilityId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
recurrenceEditType - RecurrenceEditTypeEnum
|
Example
{
"availabilityId": "4",
"clientMutationId": "xyz789",
"recurrenceEditType": "ALL"
}
DestroyAvailabilityPayload
Description
Autogenerated return type of DestroyAvailability
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Availability
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Availability
}
DestroyCalendarEventInput
Description
Autogenerated input type of DestroyCalendarEvent
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
|
recurrenceEditType - RecurrenceEditTypeEnum
|
Example
{
"clientMutationId": "xyz789",
"id": 4,
"recurrenceEditType": "ALL"
}
DestroyCalendarEventPayload
Description
Autogenerated return type of DestroyCalendarEvent
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - CalendarEvent
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": CalendarEvent
}
DestroyChecklistInput
DestroyChecklistPayload
Description
Autogenerated return type of DestroyChecklist
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Checklist
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Checklist
}
DestroyCommentInput
DestroyCommentPayload
Description
Autogenerated return type of DestroyComment
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
DestroyDocumentInput
DestroyDocumentPayload
Description
Autogenerated return type of DestroyDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
DestroyFolderInput
DestroyFolderPayload
Description
Autogenerated return type of DestroyFolder
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Folder
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Folder
}
DestroyGroupInput
DestroyGroupPayload
Description
Autogenerated return type of DestroyGroup
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Group
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Group
}
DestroyJobSiteInput
DestroyJobSitePayload
Description
Autogenerated return type of DestroyJobSite
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JobSite
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JobSite
}
DestroyJoinCodeInput
DestroyJoinCodePayload
Description
Autogenerated return type of DestroyJoinCode
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JoinCode
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": JoinCode
}
DestroyLeaveInput
DestroyLeavePayload
Description
Autogenerated return type of DestroyLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveRequest
}
DestroyMessageBoardInput
DestroyMessageBoardPayload
Description
Autogenerated return type of DestroyMessageBoard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoard
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoard
}
DestroyMessageBoardPostInput
DestroyMessageBoardPostPayload
Description
Autogenerated return type of DestroyMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
DestroyMessageInput
DestroyMessagePayload
Description
Autogenerated return type of DestroyMessage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatMessage
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatMessage
}
DestroyReactionInput
DestroyReactionPayload
Description
Autogenerated return type of DestroyReaction
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
DestroyScheduleInput
DestroySchedulePayload
Description
Autogenerated return type of DestroySchedule
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Schedule
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Schedule
}
DestroySchedulePhotoInput
DestroySchedulePhotoPayload
Description
Autogenerated return type of DestroySchedulePhoto
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - SchedulePhoto
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": SchedulePhoto
}
DestroyShiftBatchInput
DestroyShiftBatchPayload
Description
Autogenerated return type of DestroyShiftBatch
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftBatch
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftBatch
}
DestroyShiftInput
Description
Autogenerated input type of DestroyShift
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
recurrenceEditType - RecurrenceEditTypeEnum
|
|
shiftId - ID!
|
Example
{
"clientMutationId": "xyz789",
"recurrenceEditType": "ALL",
"shiftId": "4"
}
DestroyShiftOfferInput
DestroyShiftOfferPayload
Description
Autogenerated return type of DestroyShiftOffer
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftOffer
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftOffer
}
DestroyShiftPayload
Description
Autogenerated return type of DestroyShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
DestroyShiftSwapInput
DestroyShiftSwapPayload
Description
Autogenerated return type of DestroyShiftSwap
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftSwap
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftSwap
}
DestroyShiftTemplateInput
DestroyShiftTemplatePayload
Description
Autogenerated return type of DestroyShiftTemplate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftTemplate
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftTemplate
}
DestroyShiftsInput
DestroyShiftsPayload
Description
Autogenerated return type of DestroyShifts
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Shift!]!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Shift]
}
DestroyTaskInput
DestroyTaskPayload
Description
Autogenerated return type of DestroyTask
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
DestroyTimeCardInput
DestroyTimeCardPayload
Description
Autogenerated return type of DestroyTimeCard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - TimeCard
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": TimeCard
}
DestroyTimesheetInput
DestroyTimesheetPayload
Description
Autogenerated return type of DestroyTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
DestroyWorkspaceSampleDataInput
Description
Autogenerated input type of DestroyWorkspaceSampleData
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{"clientMutationId": "xyz789"}
DestroyWorkspaceSampleDataPayload
Description
Autogenerated return type of DestroyWorkspaceSampleData
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": true
}
Device
Document
Fields
| Field Name | Description |
|---|---|
acknowledgementRequired - Boolean!
|
|
acknowledgements - [Acknowledgement!]
|
|
allUsersAssigned - Boolean!
|
|
archived - Boolean!
|
|
assignedGroups - [Group!]
|
|
assignees - [User!]
|
|
assignmentType - DocumentAssignmentEnum!
|
|
color - String
|
|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
deletedAt - ISO8601DateTime
|
|
documentAttachments - [DocumentAttachment!]!
|
|
expiredAt - ISO8601DateTime
|
|
folder - Folder
|
|
id - ID!
|
|
name - String!
|
|
notes - String
|
|
pinnedAt - ISO8601DateTime
|
|
shareWithNewHires - Boolean!
|
|
state - DocumentStateEnum!
|
|
tags - [Tag!]
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"acknowledgementRequired": true,
"acknowledgements": [Acknowledgement],
"allUsersAssigned": false,
"archived": true,
"assignedGroups": [Group],
"assignees": [User],
"assignmentType": "PERSONAL",
"color": "abc123",
"createdAt": ISO8601DateTime,
"creator": User,
"deletedAt": ISO8601DateTime,
"documentAttachments": [DocumentAttachment],
"expiredAt": ISO8601DateTime,
"folder": Folder,
"id": "4",
"name": "abc123",
"notes": "xyz789",
"pinnedAt": ISO8601DateTime,
"shareWithNewHires": false,
"state": "DRAFT",
"tags": [Tag],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
DocumentAssignmentEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PERSONAL"
DocumentAttachment
Fields
| Field Name | Description |
|---|---|
attachment - String!
|
|
createdAt - ISO8601DateTime!
|
|
documentId - ID!
|
|
id - ID!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"attachment": "abc123",
"createdAt": ISO8601DateTime,
"documentId": 4,
"id": "4",
"updatedAt": ISO8601DateTime
}
DocumentAttachmentInput
Fields
| Input Field | Description |
|---|---|
attachmentKey - String!
|
Example
{"attachmentKey": "xyz789"}
DocumentConnection
Description
The connection type for Document.
Fields
| Field Name | Description |
|---|---|
edges - [DocumentEdge]
|
A list of edges. |
nodes - [Document]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [DocumentEdge],
"nodes": [Document],
"pageInfo": PageInfo,
"totalCount": 987
}
DocumentEdge
DocumentFilter
Fields
| Input Field | Description |
|---|---|
_or - [DocumentFilter!]
|
|
archived - Boolean
|
|
assigneeIds - [ID!]
|
|
creatorIds - [ID!]
|
|
documentStates - [DocumentStateEnum!]
|
|
folderIds - [ID!]
|
|
tagIds - [ID!]
|
Example
{
"_or": [DocumentFilter],
"archived": true,
"assigneeIds": [4],
"creatorIds": ["4"],
"documentStates": ["DRAFT"],
"folderIds": ["4"],
"tagIds": [4]
}
DocumentStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DRAFT"
DowngradeSubscriptionPlanInput
DowngradeSubscriptionPlanPayload
Description
Autogenerated return type of DowngradeSubscriptionPlan
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": true
}
DownloadFileInput
DownloadFilePayload
Description
Autogenerated return type of DownloadFile
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - DownloadFileResult
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": DownloadFileResult
}
DownloadFileResult
Fields
| Field Name | Description |
|---|---|
url - String!
|
Example
{"url": "abc123"}
DraftLeaveInput
Description
Autogenerated input type of DraftLeave
Fields
| Input Field | Description |
|---|---|
allDay - Boolean!
|
|
approverId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
days - [LeaveDayInput!]!
|
|
employeeId - ID!
|
|
from - ISO8601DateTime!
|
|
leaveCategoryId - ID!
|
|
paid - Boolean
|
|
reason - String
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
Example
{
"allDay": true,
"approverId": 4,
"clientMutationId": "xyz789",
"days": [LeaveDayInput],
"employeeId": 4,
"from": ISO8601DateTime,
"leaveCategoryId": "4",
"paid": true,
"reason": "abc123",
"timezone": "abc123",
"to": ISO8601DateTime
}
DraftLeavePayload
Description
Autogenerated return type of DraftLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
DraftTimesheetInput
Description
Autogenerated input type of DraftTimesheet
Fields
| Input Field | Description |
|---|---|
breaks - [TimesheetBreakInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
employeeId - ID!
|
|
from - ISO8601DateTime!
|
|
groupId - ID
|
|
scheduleId - ID
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
Example
{
"breaks": [TimesheetBreakInput],
"clientMutationId": "xyz789",
"employeeId": "4",
"from": ISO8601DateTime,
"groupId": "4",
"scheduleId": "4",
"timezone": "abc123",
"to": ISO8601DateTime
}
DraftTimesheetPayload
Description
Autogenerated return type of DraftTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
EmployeeAvailabilityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVAL_REQUIRED"
EmployeeGetStartedStep
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - EmployeeGetStartedStepNameEnum!
|
|
order - Int!
|
|
state - GetStartedStepStateEnum!
|
Example
{"id": 4, "name": "CLOCK_IN", "order": 123, "state": "FINISHED"}
EmployeeGetStartedStepNameEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOCK_IN"
EmployeeImportRequest
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
csvFile - String
|
|
data - JSON!
|
|
id - ID!
|
|
requester - User!
|
|
state - ImportRequestStateEnum!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"csvFile": "xyz789",
"data": {},
"id": "4",
"requester": User,
"state": "DONE",
"updatedAt": ISO8601DateTime
}
ExportScheduleFormatEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IMAGE"
ExportScheduleInput
Description
Autogenerated input type of ExportSchedule
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
format - ExportScheduleFormatEnum
|
|
fromTime - ISO8601DateTime!
|
|
groupId - ID
|
|
scheduleId - ID
|
|
shiftStates - [ShiftStateEnum!]
|
|
toTime - ISO8601DateTime!
|
Example
{
"clientMutationId": "xyz789",
"format": "IMAGE",
"fromTime": ISO8601DateTime,
"groupId": "4",
"scheduleId": "4",
"shiftStates": ["ABSENT"],
"toTime": ISO8601DateTime
}
ExportSchedulePayload
Description
Autogenerated return type of ExportSchedule
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": true
}
ExportTimesheetInput
Description
Autogenerated input type of ExportTimesheet
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
employeeIds - [ID!]
|
|
fromTime - ISO8601DateTime!
|
|
scheduleId - ID
|
|
toTime - ISO8601DateTime!
|
Example
{
"clientMutationId": "xyz789",
"employeeIds": ["4"],
"fromTime": ISO8601DateTime,
"scheduleId": "4",
"toTime": ISO8601DateTime
}
ExportTimesheetPayload
Description
Autogenerated return type of ExportTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
FinishEmployeeGetStartedStepInput
FinishEmployeeGetStartedStepPayload
Description
Autogenerated return type of FinishEmployeeGetStartedStep
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - EmployeeGetStartedStep
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": EmployeeGetStartedStep
}
FinishTaskInput
FinishTaskPayload
Description
Autogenerated return type of FinishTask
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Task
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Task
}
FinishWorkspaceGetStartedStepInput
FinishWorkspaceGetStartedStepPayload
Description
Autogenerated return type of FinishWorkspaceGetStartedStep
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - WorkspaceGetStartedStep
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": WorkspaceGetStartedStep
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
Folder
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
deletedAt - ISO8601DateTime
|
|
description - String
|
|
documents - [Document!]
|
|
id - ID!
|
|
level - Int!
|
|
name - String!
|
|
parent - Folder
|
|
private - Boolean
|
|
subFolders - [Folder!]
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"createdAt": ISO8601DateTime,
"creator": User,
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"documents": [Document],
"id": 4,
"level": 123,
"name": "xyz789",
"parent": Folder,
"private": false,
"subFolders": [Folder],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
FolderFilter
Fields
| Input Field | Description |
|---|---|
_or - [FolderFilter!]
|
|
creatorIds - [ID!]
|
|
ignoreSelfAndParent - ID
|
|
levels - [Int!]
|
Example
{
"_or": [FolderFilter],
"creatorIds": [4],
"ignoreSelfAndParent": "4",
"levels": [123]
}
GenerateDirectUploadUrlInput
Description
Autogenerated input type of GenerateDirectUploadUrl
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
uploader - UploaderEnum!
|
Example
{
"clientMutationId": "abc123",
"uploader": "AVATAR"
}
GenerateDirectUploadUrlPayload
Description
Autogenerated return type of GenerateDirectUploadUrl
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - AWS4Request
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": AWS4Request
}
GetStartedStepStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FINISHED"
Group
Fields
| Field Name | Description |
|---|---|
color - String!
|
|
colorName - String!
|
|
createdAt - ISO8601DateTime!
|
|
default - Boolean
|
|
deletedAt - ISO8601DateTime
|
|
id - ID!
|
|
name - String!
|
|
updatedAt - ISO8601DateTime!
|
|
users - [User!]!
|
|
Arguments
|
|
usersCount - Int!
|
|
Example
{
"color": "xyz789",
"colorName": "abc123",
"createdAt": ISO8601DateTime,
"default": false,
"deletedAt": ISO8601DateTime,
"id": "4",
"name": "abc123",
"updatedAt": ISO8601DateTime,
"users": [User],
"usersCount": 987
}
GroupFilter
Fields
| Input Field | Description |
|---|---|
seed - Boolean
|
|
state - GroupFilterStateEnum
|
|
userId - ID
|
Example
{
"seed": true,
"state": "ACTIVE",
"userId": "4"
}
GroupFilterStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
GroupInput
GroupSearchPayload
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
ImportEmployeesInput
ImportEmployeesPayload
Description
Autogenerated return type of ImportEmployees
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - EmployeeImportRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": EmployeeImportRequest
}
ImportRequestStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DONE"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InviteToChannelInput
InviteToChannelPayload
Description
Autogenerated return type of InviteToChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatChannel
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatChannel
}
JSON
Description
Represents untyped JSON
Example
{}
JobSite
Fields
| Field Name | Description |
|---|---|
address - String!
|
|
attachments - [JobSiteAttachment!]
|
|
color - String
|
|
createdAt - ISO8601DateTime!
|
|
geoLat - Float!
|
|
geoLong - Float!
|
|
id - ID!
|
|
name - String!
|
|
note - String
|
|
payRate - JobSitePayRate
|
|
schedules - [Schedule!]!
|
|
updatedAt - ISO8601DateTime!
|
|
wifiBssid - String
|
|
wifiSsid - String
|
Example
{
"address": "xyz789",
"attachments": [JobSiteAttachment],
"color": "xyz789",
"createdAt": ISO8601DateTime,
"geoLat": 987.65,
"geoLong": 123.45,
"id": "4",
"name": "xyz789",
"note": "xyz789",
"payRate": JobSitePayRate,
"schedules": [Schedule],
"updatedAt": ISO8601DateTime,
"wifiBssid": "xyz789",
"wifiSsid": "xyz789"
}
JobSiteAttachment
Fields
| Field Name | Description |
|---|---|
attachment - String!
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
jobSiteId - ID
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"attachment": "abc123",
"createdAt": ISO8601DateTime,
"id": "4",
"jobSiteId": 4,
"updatedAt": ISO8601DateTime
}
JobSiteAttachmentInput
Fields
| Input Field | Description |
|---|---|
attachmentKey - String
|
Example
{"attachmentKey": "xyz789"}
JobSiteConnection
Description
The connection type for JobSite.
Fields
| Field Name | Description |
|---|---|
edges - [JobSiteEdge]
|
A list of edges. |
nodes - [JobSite]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [JobSiteEdge],
"nodes": [JobSite],
"pageInfo": PageInfo,
"totalCount": 123
}
JobSiteEdge
JobSiteFilter
Fields
| Input Field | Description |
|---|---|
_or - [JobSiteFilter!]
|
|
color - String
|
|
keyword - String
|
|
scheduleIds - [ID!]
|
Example
{
"_or": [JobSiteFilter],
"color": "abc123",
"keyword": "abc123",
"scheduleIds": ["4"]
}
JobSitePayRate
JobSitePayRateInput
Fields
| Input Field | Description |
|---|---|
rate - Float!
|
Example
{"rate": 123.45}
JoinChannelInput
JoinChannelPayload
Description
Autogenerated return type of JoinChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChannelMember
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChannelMember
}
JoinCode
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
effectiveUntil - ISO8601DateTime!
|
|
id - ID!
|
|
requireApproval - Boolean!
|
Example
{
"code": "xyz789",
"effectiveUntil": ISO8601DateTime,
"id": 4,
"requireApproval": false
}
JoinRequest
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
state - JoinRequestStateEnum!
|
|
user - User!
|
|
userInfo - JSON
|
Example
{
"id": "4",
"state": "APPROVED",
"user": User,
"userInfo": {}
}
JoinRequestConnection
Description
The connection type for JoinRequest.
Fields
| Field Name | Description |
|---|---|
edges - [JoinRequestEdge]
|
A list of edges. |
nodes - [JoinRequest]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [JoinRequestEdge],
"nodes": [JoinRequest],
"pageInfo": PageInfo,
"totalCount": 987
}
JoinRequestEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - JoinRequest
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": JoinRequest
}
JoinRequestFilter
Fields
| Input Field | Description |
|---|---|
_or - [JoinRequestFilter!]
|
|
state - JoinRequestStateEnum
|
Example
{"_or": [JoinRequestFilter], "state": "APPROVED"}
JoinRequestStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"APPROVED"
JwtPayload
Fields
| Field Name | Description |
|---|---|
expiredAt - ISO8601DateTime!
|
|
jwtToken - String!
|
|
whoami - Whoami!
|
|
workspaces - [Workspace!]!
|
Example
{
"expiredAt": ISO8601DateTime,
"jwtToken": "xyz789",
"whoami": Whoami,
"workspaces": [Workspace]
}
KickFromChannelInput
KickFromChannelPayload
Description
Autogenerated return type of KickFromChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatChannel
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatChannel
}
KioskJwtPayload
Fields
| Field Name | Description |
|---|---|
jwtToken - String!
|
|
whoami - Whoami!
|
|
workspaces - [Workspace!]!
|
Example
{
"jwtToken": "xyz789",
"whoami": Whoami,
"workspaces": [Workspace]
}
KioskPunchAttachmentInput
Fields
| Input Field | Description |
|---|---|
photoKey - String
|
Example
{"photoKey": "xyz789"}
KioskPunchData
Fields
| Input Field | Description |
|---|---|
punchType - TimeCardPunchTypeEnum!
|
|
timeCardId - ID!
|
Example
{"punchType": "CLOCK_IN", "timeCardId": "4"}
KioskPunchInput
Description
Autogenerated input type of KioskPunch
Fields
| Input Field | Description |
|---|---|
attachment - KioskPunchAttachmentInput
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
data - KioskPunchData
|
Example
{
"attachment": KioskPunchAttachmentInput,
"clientMutationId": "abc123",
"data": KioskPunchData
}
KioskPunchPayload
Description
Autogenerated return type of KioskPunch
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - KioskPunchResponse
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": KioskPunchResponse
}
KioskPunchResponse
Fields
| Field Name | Description |
|---|---|
state - TimeCardStateEnum
|
|
timeCards - [KioskTimeCard!]!
|
|
whoami - Whoami!
|
Example
{
"state": "CLOCKED_IN",
"timeCards": [KioskTimeCard],
"whoami": Whoami
}
KioskTimeCard
Fields
| Field Name | Description |
|---|---|
autoDeductedUnpaidBreakDuration - Minute!
|
|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
endTime - ISO8601DateTime
|
|
group - Group
|
|
hasWarning - Boolean!
|
|
id - ID!
|
|
note - String
|
|
punches - [TimeCardPunch!]!
|
|
schedule - Schedule
|
|
shift - Shift
|
|
startTime - ISO8601DateTime
|
|
state - TimeCardStateEnum!
|
|
timezone - String!
|
|
totalDuration - Minute!
|
Example
{
"autoDeductedUnpaidBreakDuration": Minute,
"createdAt": ISO8601DateTime,
"creator": User,
"endTime": ISO8601DateTime,
"group": Group,
"hasWarning": false,
"id": "4",
"note": "abc123",
"punches": [TimeCardPunch],
"schedule": Schedule,
"shift": Shift,
"startTime": ISO8601DateTime,
"state": "CLOCKED_IN",
"timezone": "xyz789",
"totalDuration": Minute
}
LastViewedAtChannelInput
Description
Autogenerated input type of LastViewedAtChannel
Fields
| Input Field | Description |
|---|---|
channelId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
lastMessageAt - ISO8601DateTime!
|
Example
{
"channelId": "4",
"clientMutationId": "xyz789",
"lastMessageAt": ISO8601DateTime
}
LastViewedAtChannelPayload
Description
Autogenerated return type of LastViewedAtChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChannelMember
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChannelMember
}
LeaveCategory
LeaveCategoryConnection
Description
The connection type for LeaveCategory.
Fields
| Field Name | Description |
|---|---|
edges - [LeaveCategoryEdge]
|
A list of edges. |
nodes - [LeaveCategory]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [LeaveCategoryEdge],
"nodes": [LeaveCategory],
"pageInfo": PageInfo,
"totalCount": 123
}
LeaveCategoryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - LeaveCategory
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": LeaveCategory
}
LeaveCategoryFilter
Fields
| Input Field | Description |
|---|---|
includeDisabled - Boolean
|
Example
{"includeDisabled": false}
LeaveCategoryInput
LeaveChannelInput
LeaveChannelPayload
Description
Autogenerated return type of LeaveChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChannelMember
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChannelMember
}
LeaveDayInput
Fields
| Input Field | Description |
|---|---|
date - ISO8601DateTime!
|
|
minutes - Minute!
|
Example
{
"date": ISO8601DateTime,
"minutes": Minute
}
LeaveFilter
Fields
| Input Field | Description |
|---|---|
_or - [LeaveFilter!]
|
|
approverIds - [ID!]
|
|
employeeIds - [ID!]
|
|
fromTime - ISO8601DateTime
|
|
leaveCategoryIds - [ID!]
|
|
leaveStates - [LeaveRequestStateEnum!]
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [LeaveFilter],
"approverIds": ["4"],
"employeeIds": [4],
"fromTime": ISO8601DateTime,
"leaveCategoryIds": [4],
"leaveStates": ["APPROVED"],
"scheduleIds": [4],
"toTime": ISO8601DateTime
}
LeaveOrder
Fields
| Input Field | Description |
|---|---|
column - LeaveOrderColumnsEnum!
|
|
direction - OrderOrientEnum!
|
Example
{"column": "FROM", "direction": "ASC"}
LeaveOrderColumnsEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FROM"
LeaveReportFilter
Fields
| Input Field | Description |
|---|---|
_or - [LeaveReportFilter!]
|
|
fromTime - ISO8601DateTime
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [LeaveReportFilter],
"fromTime": ISO8601DateTime,
"scheduleIds": ["4"],
"toTime": ISO8601DateTime
}
LeaveReportResult
LeaveRequest
Fields
| Field Name | Description |
|---|---|
allDay - Boolean!
|
|
approvedAt - ISO8601DateTime
|
|
approver - User!
|
|
approverId - ID!
|
|
canceledAt - ISO8601DateTime
|
|
days - [LeaveRequestDay!]!
|
|
draftAt - ISO8601DateTime!
|
|
employee - User!
|
|
from - ISO8601DateTime!
|
|
id - ID!
|
|
leaveCategory - LeaveCategory!
|
|
paid - Boolean!
|
|
processedAt - ISO8601DateTime
|
|
reason - String
|
|
rejectedAt - ISO8601DateTime
|
|
requester - User!
|
|
state - LeaveRequestStateEnum!
|
|
submittedAt - ISO8601DateTime
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
|
totalDuration - Minute!
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"allDay": false,
"approvedAt": ISO8601DateTime,
"approver": User,
"approverId": 4,
"canceledAt": ISO8601DateTime,
"days": [LeaveRequestDay],
"draftAt": ISO8601DateTime,
"employee": User,
"from": ISO8601DateTime,
"id": 4,
"leaveCategory": LeaveCategory,
"paid": true,
"processedAt": ISO8601DateTime,
"reason": "abc123",
"rejectedAt": ISO8601DateTime,
"requester": User,
"state": "APPROVED",
"submittedAt": ISO8601DateTime,
"timezone": "abc123",
"to": ISO8601DateTime,
"totalDuration": Minute,
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
LeaveRequestConnection
Description
The connection type for LeaveRequest.
Fields
| Field Name | Description |
|---|---|
edges - [LeaveRequestEdge]
|
A list of edges. |
nodes - [LeaveRequest]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [LeaveRequestEdge],
"nodes": [LeaveRequest],
"pageInfo": PageInfo,
"totalCount": 123
}
LeaveRequestDay
Fields
| Field Name | Description |
|---|---|
date - ISO8601DateTime!
|
|
minutes - Minute!
|
Example
{
"date": ISO8601DateTime,
"minutes": Minute
}
LeaveRequestEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - LeaveRequest
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": LeaveRequest
}
LeaveRequestStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
LinkUserWithDeviceInput
Description
Autogenerated input type of LinkUserWithDevice
Example
{
"appVersion": "abc123",
"buildVersion": "abc123",
"clientMutationId": "abc123",
"name": "abc123",
"platform": "abc123",
"token": "abc123"
}
LinkUserWithDevicePayload
Description
Autogenerated return type of LinkUserWithDevice
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Device
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Device
}
LoginSession
MarkAllInboxAsReadInput
Description
Autogenerated input type of MarkAllInboxAsRead
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{"clientMutationId": "abc123"}
MarkAllInboxAsReadPayload
Description
Autogenerated return type of MarkAllInboxAsRead
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [ChatMessage!]!
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [ChatMessage]
}
MarkAllNotificationsAsReadInput
Description
Autogenerated input type of MarkAllNotificationsAsRead
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{"clientMutationId": "xyz789"}
MarkAllNotificationsAsReadPayload
Description
Autogenerated return type of MarkAllNotificationsAsRead
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean!
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
MarkNotificationsAsReadInput
Description
Autogenerated input type of MarkNotificationsAsRead
Example
{
"actedUpon": true,
"clientMutationId": "abc123",
"notificationIds": ["4"]
}
MarkNotificationsAsReadPayload
Description
Autogenerated return type of MarkNotificationsAsRead
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Notification!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Notification]
}
MembershipSetting
Fields
| Field Name | Description |
|---|---|
emailLeaveRequest - Boolean!
|
|
emailManageAvailabilityRequest - Boolean!
|
|
emailManageDocument - Boolean!
|
|
emailManageLeaveRequest - Boolean!
|
|
emailManageMessageBoard - Boolean!
|
|
emailManageShiftOfferRequest - Boolean!
|
|
emailManageShiftSwapRequest - Boolean!
|
|
emailManageTimesheet - Boolean!
|
|
emailSchedulePosted - Boolean!
|
|
emailShiftOfferRequest - Boolean!
|
|
emailShiftReminder - Boolean!
|
|
emailShiftSwapRequest - Boolean!
|
|
emailSummary - Boolean!
|
|
emailTimesheet - Boolean!
|
|
id - ID!
|
|
maxDurationPerWeek - Minute
|
|
notificationShiftLate - Boolean!
|
|
typicalWorkDuration - Minute
|
Example
{
"emailLeaveRequest": false,
"emailManageAvailabilityRequest": false,
"emailManageDocument": false,
"emailManageLeaveRequest": true,
"emailManageMessageBoard": false,
"emailManageShiftOfferRequest": false,
"emailManageShiftSwapRequest": false,
"emailManageTimesheet": false,
"emailSchedulePosted": false,
"emailShiftOfferRequest": true,
"emailShiftReminder": true,
"emailShiftSwapRequest": false,
"emailSummary": true,
"emailTimesheet": true,
"id": 4,
"maxDurationPerWeek": Minute,
"notificationShiftLate": true,
"typicalWorkDuration": Minute
}
MessageActionInput
Description
Autogenerated input type of MessageAction
Example
{
"actionId": "abc123",
"clientMutationId": "xyz789",
"messageId": "4",
"value": "abc123"
}
MessageActionPayload
Description
Autogenerated return type of MessageAction
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageActionResult
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageActionResult
}
MessageActionResult
Fields
| Field Name | Description |
|---|---|
blocks - JSON
|
|
message - String
|
|
responseType - MessageResponseTypeEnum!
|
Example
{
"blocks": {},
"message": "abc123",
"responseType": "DELETE_ORIGINAL"
}
MessageAddedPayload
Description
Autogenerated return type of MessageAdded
Fields
| Field Name | Description |
|---|---|
message - ChatMessage!
|
Example
{"message": ChatMessage}
MessageAttachmentInput
Fields
| Input Field | Description |
|---|---|
attachmentKey - String!
|
|
localUrl - String
|
For optimistic update on mobile |
metadata - ChatAttachmentMetadataInput
|
|
type - ChatAttachmentEnum!
|
Example
{
"attachmentKey": "xyz789",
"localUrl": "abc123",
"metadata": ChatAttachmentMetadataInput,
"type": "DOCUMENT"
}
MessageBoard
Fields
| Field Name | Description |
|---|---|
categories - [MessageBoardCategory!]
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
description - String
|
|
id - ID!
|
|
messageBoardsMembers - [MessageBoardsMember!]
|
|
name - String!
|
|
pinnedAt - ISO8601DateTime
|
|
shareWithNewHires - Boolean!
|
|
unreadMessagesCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"categories": [MessageBoardCategory],
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"description": "xyz789",
"id": 4,
"messageBoardsMembers": [MessageBoardsMember],
"name": "xyz789",
"pinnedAt": ISO8601DateTime,
"shareWithNewHires": false,
"unreadMessagesCount": 123,
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
MessageBoardCategory
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
id - ID!
|
|
messageBoard - [MessageBoard!]
|
|
name - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"id": 4,
"messageBoard": [MessageBoard],
"name": "xyz789",
"updatedAt": ISO8601DateTime
}
MessageBoardFilter
Fields
| Input Field | Description |
|---|---|
_or - [MessageBoardFilter!]
|
|
memberIds - [ID!]
|
|
pinnedBoard - Boolean
|
Example
{
"_or": [MessageBoardFilter],
"memberIds": [4],
"pinnedBoard": true
}
MessageBoardPost
Fields
| Field Name | Description |
|---|---|
acknowledgementRequired - Boolean
|
|
acknowledgements - [Acknowledgement!]
|
|
archivedAt - ISO8601DateTime
|
|
author - User!
|
|
blocks - JSON!
|
|
board - MessageBoard!
|
|
category - MessageBoardCategory
|
|
commentEnabled - Boolean
|
|
commentsCount - Int
|
|
confirmationRequiredUsers - [User!]
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
draftAt - ISO8601DateTime
|
|
id - ID!
|
|
images - [MessageBoardPostImage!]
|
|
messageBoardId - ID!
|
|
notifyUsers - [User!]
|
|
pinnedAt - ISO8601DateTime
|
|
publishedAt - ISO8601DateTime
|
|
reactions - [Reaction!]
|
|
readAt - ISO8601DateTime
|
|
scheduledPostAt - ISO8601DateTime
|
|
state - MessageBoardPostStateEnum!
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"acknowledgementRequired": false,
"acknowledgements": [Acknowledgement],
"archivedAt": ISO8601DateTime,
"author": User,
"blocks": {},
"board": MessageBoard,
"category": MessageBoardCategory,
"commentEnabled": true,
"commentsCount": 987,
"confirmationRequiredUsers": [User],
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"draftAt": ISO8601DateTime,
"id": "4",
"images": [MessageBoardPostImage],
"messageBoardId": "4",
"notifyUsers": [User],
"pinnedAt": ISO8601DateTime,
"publishedAt": ISO8601DateTime,
"reactions": [Reaction],
"readAt": ISO8601DateTime,
"scheduledPostAt": ISO8601DateTime,
"state": "ARCHIVED",
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
MessageBoardPostConnection
Description
The connection type for MessageBoardPost.
Fields
| Field Name | Description |
|---|---|
edges - [MessageBoardPostEdge]
|
A list of edges. |
nodes - [MessageBoardPost]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [MessageBoardPostEdge],
"nodes": [MessageBoardPost],
"pageInfo": PageInfo,
"totalCount": 123
}
MessageBoardPostEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - MessageBoardPost
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": MessageBoardPost
}
MessageBoardPostFilter
Fields
| Input Field | Description |
|---|---|
_or - [MessageBoardPostFilter!]
|
|
authorIds - [ID!]
|
|
categories - [ID!]
|
|
messageBoardIds - [ID!]
|
|
pinnedPost - Boolean
|
|
postDate - ISO8601DateTime
|
|
postStates - [MessageBoardPostStateEnum!]
|
|
viewedPost - Boolean
|
Example
{
"_or": [MessageBoardPostFilter],
"authorIds": ["4"],
"categories": ["4"],
"messageBoardIds": ["4"],
"pinnedPost": true,
"postDate": ISO8601DateTime,
"postStates": ["ARCHIVED"],
"viewedPost": true
}
MessageBoardPostImage
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
image - String!
|
|
messageBoardPostId - ID!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"image": "abc123",
"messageBoardPostId": "4",
"updatedAt": ISO8601DateTime
}
MessageBoardPostImageInput
MessageBoardPostStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ARCHIVED"
MessageBoardsMember
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
id - ID!
|
|
messageBoard - MessageBoard!
|
|
role - MessageBoardsMemberRoleEnum!
|
|
updatedAt - ISO8601DateTime!
|
|
user - User!
|
Example
{
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"id": "4",
"messageBoard": MessageBoard,
"role": "ADMIN",
"updatedAt": ISO8601DateTime,
"user": User
}
MessageBoardsMemberInput
Fields
| Input Field | Description |
|---|---|
_destroy - Boolean
|
|
messageBoardsMemberId - ID
|
|
role - MessageBoardsMemberRoleEnum!
|
|
userId - ID
|
Example
{
"_destroy": true,
"messageBoardsMemberId": "4",
"role": "ADMIN",
"userId": "4"
}
MessageBoardsMemberRoleEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
MessageDeletedPayload
Description
Autogenerated return type of MessageDeleted
Fields
| Field Name | Description |
|---|---|
message - ChatMessage!
|
Example
{"message": ChatMessage}
MessageResponseTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELETE_ORIGINAL"
MessageUpdatedPayload
Description
Autogenerated return type of MessageUpdated
Fields
| Field Name | Description |
|---|---|
message - ChatMessage!
|
Example
{"message": ChatMessage}
MeteredUsage
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
type - String!
|
|
updatedAt - ISO8601DateTime!
|
|
usageCount - Float!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"type": "xyz789",
"updatedAt": ISO8601DateTime,
"usageCount": 123.45
}
Minute
Description
Minute, used for all kind of duration
Example
Minute
MutationError
Notification
Fields
| Field Name | Description |
|---|---|
actedUponAt - ISO8601DateTime
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
message - String
|
|
notificationType - NotificationTypeEnum!
|
|
readAt - ISO8601DateTime
|
|
recipient - User!
|
|
recipientId - ID!
|
|
referenceObject - ReferenceObject
|
|
sender - User!
|
|
senderId - ID!
|
|
title - String
|
|
updatedAt - ISO8601DateTime!
|
|
workspaceId - ID!
|
Example
{
"actedUponAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"id": 4,
"message": "abc123",
"notificationType": "DOCUMENT_ACKNOWLEDGED",
"readAt": ISO8601DateTime,
"recipient": User,
"recipientId": "4",
"referenceObject": Document,
"sender": User,
"senderId": 4,
"title": "xyz789",
"updatedAt": ISO8601DateTime,
"workspaceId": "4"
}
NotificationAddedPayload
Description
Autogenerated return type of NotificationAdded
Fields
| Field Name | Description |
|---|---|
notification - Notification!
|
Example
{"notification": Notification}
NotificationConnection
Description
The connection type for Notification.
Fields
| Field Name | Description |
|---|---|
edges - [NotificationEdge]
|
A list of edges. |
nodes - [Notification]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [NotificationEdge],
"nodes": [Notification],
"pageInfo": PageInfo,
"totalCount": 123
}
NotificationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Notification
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": Notification
}
NotificationFilter
Fields
| Input Field | Description |
|---|---|
_or - [NotificationFilter!]
|
|
fromTime - ISO8601DateTime
|
|
toTime - ISO8601DateTime
|
|
type - NotificationTypeEnum
|
|
unread - Boolean
|
Example
{
"_or": [NotificationFilter],
"fromTime": ISO8601DateTime,
"toTime": ISO8601DateTime,
"type": "DOCUMENT_ACKNOWLEDGED",
"unread": false
}
NotificationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOCUMENT_ACKNOWLEDGED"
OfferShiftInput
OfferShiftPayload
Description
Autogenerated return type of OfferShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Shift
}
OrderOrientEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
OwnerInfoInput
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
PayRun
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
PayRunConnection
Description
The connection type for PayRun.
Fields
| Field Name | Description |
|---|---|
edges - [PayRunEdge]
|
A list of edges. |
nodes - [PayRun]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [PayRunEdge],
"nodes": [PayRun],
"pageInfo": PageInfo,
"totalCount": 123
}
PayRunEdge
PayRunFilter
Fields
| Input Field | Description |
|---|---|
_or - [PayRunFilter!]
|
|
fromTime - ISO8601DateTime
|
|
payCalendarIds - [ID!]
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [PayRunFilter],
"fromTime": ISO8601DateTime,
"payCalendarIds": [4],
"toTime": ISO8601DateTime
}
Payslip
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
PayslipConnection
Description
The connection type for Payslip.
Fields
| Field Name | Description |
|---|---|
edges - [PayslipEdge]
|
A list of edges. |
nodes - [Payslip]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [PayslipEdge],
"nodes": [Payslip],
"pageInfo": PageInfo,
"totalCount": 123
}
PayslipEdge
PayslipFilter
Fields
| Input Field | Description |
|---|---|
_or - [PayslipFilter!]
|
Example
{"_or": [PayslipFilter]}
PayslipOrder
Fields
| Input Field | Description |
|---|---|
column - PayslipOrderColumnsEnum!
|
|
direction - OrderOrientEnum!
|
Example
{"column": "CREATED_AT", "direction": "ASC"}
PayslipOrderColumnsEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED_AT"
PinDocumentInput
PinDocumentPayload
Description
Autogenerated return type of PinDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Document
}
PinMessageBoardInput
PinMessageBoardPayload
Description
Autogenerated return type of PinMessageBoard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoard
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoard
}
PinMessageBoardPostInput
PinMessageBoardPostPayload
Description
Autogenerated return type of PinMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoardPost
}
PlanIntervalEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DAY"
PlatformEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MOBILE"
PolicyMatrixItem
PublishShift
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NOTIFY_AND_REQUIRE_CONFIRMATION"
PublishShiftsInput
Description
Autogenerated input type of PublishShifts
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
publishShiftType - PublishShift
|
|
shiftIds - [ID!]!
|
Example
{
"clientMutationId": "xyz789",
"publishShiftType": "NOTIFY_AND_REQUIRE_CONFIRMATION",
"shiftIds": ["4"]
}
PublishShiftsPayload
Description
Autogenerated return type of PublishShifts
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Shift!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Shift]
}
Reactable
Description
Properties of Reactable
Types
| Union Types |
|---|
Example
Comment
ReactableTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMMENT"
Reaction
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
emoji - String!
|
|
id - ID!
|
|
reactable - Reactable!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"creator": User,
"emoji": "abc123",
"id": 4,
"reactable": Comment,
"updatedAt": ISO8601DateTime
}
ReadInboxMessageInput
ReadInboxMessagePayload
Description
Autogenerated return type of ReadInboxMessage
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatMessage
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatMessage
}
ReassignShiftInput
Description
Autogenerated input type of ReassignShift
Fields
| Input Field | Description |
|---|---|
assigneeId - ID
|
|
breakDuration - Minute
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime
|
|
endType - ShiftEndTypeInputEnum
|
|
groupId - ID
|
|
jobSiteId - ID
|
|
note - String
|
|
requireClaimApproval - Boolean
|
|
scheduleId - ID
|
|
shiftId - ID!
|
|
startTime - ISO8601DateTime
|
|
timezone - String
|
Example
{
"assigneeId": 4,
"breakDuration": Minute,
"clientMutationId": "abc123",
"color": "xyz789",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"groupId": 4,
"jobSiteId": 4,
"note": "abc123",
"requireClaimApproval": true,
"scheduleId": "4",
"shiftId": 4,
"startTime": ISO8601DateTime,
"timezone": "xyz789"
}
ReassignShiftPayload
Description
Autogenerated return type of ReassignShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
Recurrence
RecurrenceEditTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
RedeemCodeInput
RedeemCodePayload
Description
Autogenerated return type of RedeemCode
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Redemption
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Redemption
}
Redemption
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
redeemedAt - ISO8601DateTime
|
Example
{"id": 4, "redeemedAt": ISO8601DateTime}
ReferenceObject
Description
Properties of ReferenceObject
Types
| Union Types |
|---|
Example
Document
ReferenceObjectTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LEAVE_REQUEST"
RefuseShiftOfferRequestInput
RefuseShiftOfferRequestPayload
Description
Autogenerated return type of RefuseShiftOfferRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftOfferRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftOfferRequest
}
RefuseShiftSwapRequestInput
RefuseShiftSwapRequestPayload
Description
Autogenerated return type of RefuseShiftSwapRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftSwapRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ShiftSwapRequest
}
RejectJoinRequestInput
RejectJoinRequestPayload
Description
Autogenerated return type of RejectJoinRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JoinRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JoinRequest
}
RejectLeaveInput
RejectLeavePayload
Description
Autogenerated return type of RejectLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
RejectShiftClaimRequestInput
RejectShiftClaimRequestPayload
Description
Autogenerated return type of RejectShiftClaimRequest
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftClaimRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftClaimRequest
}
RejectShiftInput
RejectShiftPayload
Description
Autogenerated return type of RejectShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
RejectTimesheetInput
RejectTimesheetPayload
Description
Autogenerated return type of RejectTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
RequestKioskLoginSessionInput
Description
Autogenerated input type of RequestKioskLoginSession
Fields
| Input Field | Description |
|---|---|
authenticationMethod - AuthenticationMethod!
|
|
authenticationValue - String!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
uad - String
|
Example
{
"authenticationMethod": "EMAIL",
"authenticationValue": "xyz789",
"clientMutationId": "xyz789",
"uad": "abc123"
}
RequestKioskLoginSessionPayload
Description
Autogenerated return type of RequestKioskLoginSession
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LoginSession
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LoginSession
}
RequestLoginSessionInput
Description
Autogenerated input type of RequestLoginSession
Fields
| Input Field | Description |
|---|---|
authenticationMethod - AuthenticationMethod!
|
|
authenticationValue - String!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
source - PlatformEnum
|
|
uad - String
|
Example
{
"authenticationMethod": "EMAIL",
"authenticationValue": "xyz789",
"clientMutationId": "xyz789",
"source": "MOBILE",
"uad": "abc123"
}
RequestLoginSessionPayload
Description
Autogenerated return type of RequestLoginSession
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LoginSession
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LoginSession
}
RequestServiceTokenInput
Description
Autogenerated input type of RequestServiceToken
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
serviceId - SupportedServiceEnum!
|
Example
{
"clientMutationId": "xyz789",
"serviceId": "KIOSK"
}
RequestServiceTokenPayload
Description
Autogenerated return type of RequestServiceToken
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - String
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": "xyz789"
}
RequestToDestroyUserInput
RequestToDestroyUserPayload
Description
Autogenerated return type of RequestToDestroyUser
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": true
}
RestoreDocumentInput
RestoreDocumentPayload
Description
Autogenerated return type of RestoreDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
RestoreGroupInput
RestoreGroupPayload
Description
Autogenerated return type of RestoreGroup
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Group
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Group
}
ResubmitLeaveInput
Description
Autogenerated input type of ResubmitLeave
Fields
| Input Field | Description |
|---|---|
allDay - Boolean
|
|
approverId - ID
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
days - [LeaveDayInput!]
|
|
employeeId - ID
|
|
from - ISO8601DateTime
|
|
leaveCategoryId - ID
|
|
leaveId - ID!
|
|
paid - Boolean
|
|
reason - String
|
|
timezone - String
|
|
to - ISO8601DateTime
|
Example
{
"allDay": true,
"approverId": 4,
"clientMutationId": "xyz789",
"days": [LeaveDayInput],
"employeeId": "4",
"from": ISO8601DateTime,
"leaveCategoryId": 4,
"leaveId": "4",
"paid": false,
"reason": "abc123",
"timezone": "xyz789",
"to": ISO8601DateTime
}
ResubmitLeavePayload
Description
Autogenerated return type of ResubmitLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": LeaveRequest
}
ResubmitTimesheetInput
Description
Autogenerated input type of ResubmitTimesheet
Fields
| Input Field | Description |
|---|---|
breaks - [TimesheetBreakInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
employeeId - ID
|
|
from - ISO8601DateTime
|
|
groupId - ID
|
|
scheduleId - ID
|
|
timesheetId - ID!
|
|
timezone - String
|
|
to - ISO8601DateTime
|
Example
{
"breaks": [TimesheetBreakInput],
"clientMutationId": "xyz789",
"employeeId": "4",
"from": ISO8601DateTime,
"groupId": 4,
"scheduleId": "4",
"timesheetId": "4",
"timezone": "xyz789",
"to": ISO8601DateTime
}
ResubmitTimesheetPayload
Description
Autogenerated return type of ResubmitTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
Role
Fields
| Field Name | Description |
|---|---|
code - RoleCodeEnum!
|
|
description - String
|
|
id - ID!
|
|
name - String!
|
|
rolesUsers - [RolesUser!]!
|
Example
{
"code": "CONTRACTOR",
"description": "xyz789",
"id": 4,
"name": "xyz789",
"rolesUsers": [RolesUser]
}
RoleCodeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTRACTOR"
RoleConnection
Description
The connection type for Role.
Fields
| Field Name | Description |
|---|---|
edges - [RoleEdge]
|
A list of edges. |
nodes - [Role]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [RoleEdge],
"nodes": [Role],
"pageInfo": PageInfo,
"totalCount": 123
}
RoleEdge
RoleManagingSchedule
RoleManagingScheduleInput
RoleMetaData
Fields
| Field Name | Description |
|---|---|
managingSchedules - [RoleManagingSchedule!]
|
|
scheduleIds - [String!]
|
Use managing_schedules instead. From 1.1.25 |
schedules - [Schedule!]
|
Example
{
"managingSchedules": [RoleManagingSchedule],
"scheduleIds": ["xyz789"],
"schedules": [Schedule]
}
RoleUserInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
metaData - RoleUserMetadataInput
|
Example
{"id": 4, "metaData": RoleUserMetadataInput}
RoleUserMetadataInput
Fields
| Input Field | Description |
|---|---|
managingSchedules - [RoleManagingScheduleInput!]
|
Example
{"managingSchedules": [RoleManagingScheduleInput]}
RolesUser
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
metaData - RoleMetaData
|
|
role - Role!
|
|
user - User!
|
Example
{
"id": "4",
"metaData": RoleMetaData,
"role": Role,
"user": User
}
RoundTimesheetInput
RoundTimesheetPayload
Description
Autogenerated return type of RoundTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
SaveTrialPersonalizationInput
Description
Autogenerated input type of SaveTrialPersonalization
Example
{
"clientMutationId": "xyz789",
"companySize": "abc123",
"industry": "abc123",
"prospectId": "4",
"purposes": "abc123",
"workspaceId": 4
}
SaveTrialPersonalizationPayload
Description
Autogenerated return type of SaveTrialPersonalization
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ID
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": 4
}
Schedule
Fields
| Field Name | Description |
|---|---|
color - String!
|
|
createdAt - ISO8601DateTime!
|
|
default - Boolean!
|
|
defaultJobSite - JobSite
|
|
id - ID!
|
|
name - String!
|
|
schedulesUsers - [ScheduleUser!]!
|
|
timezone - String!
|
|
updatedAt - ISO8601DateTime!
|
|
users - [User!]!
|
Use schedule_users instead. From 1.1.25 |
Example
{
"color": "xyz789",
"createdAt": ISO8601DateTime,
"default": true,
"defaultJobSite": JobSite,
"id": "4",
"name": "abc123",
"schedulesUsers": [ScheduleUser],
"timezone": "xyz789",
"updatedAt": ISO8601DateTime,
"users": [User]
}
ScheduleConnection
Description
The connection type for Schedule.
Fields
| Field Name | Description |
|---|---|
edges - [ScheduleEdge]
|
A list of edges. |
nodes - [Schedule]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [ScheduleEdge],
"nodes": [Schedule],
"pageInfo": PageInfo,
"totalCount": 987
}
ScheduleData
Fields
| Field Name | Description |
|---|---|
availabilities - [Availability!]!
|
|
groups - [Group!]!
|
|
jobSites - [JobSite!]!
|
|
leaveRequests - [LeaveRequest!]!
|
|
shifts - [Shift!]!
|
Example
{
"availabilities": [Availability],
"groups": [Group],
"jobSites": [JobSite],
"leaveRequests": [LeaveRequest],
"shifts": [Shift]
}
ScheduleDataFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime!
|
|
scheduleIds - [ID!]!
|
|
toTime - ISO8601DateTime!
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleIds": [4],
"toTime": ISO8601DateTime
}
ScheduleEdge
ScheduleFilter
SchedulePhoto
Fields
| Field Name | Description |
|---|---|
from - ISO8601DateTime!
|
|
id - ID!
|
|
photo - String!
|
|
schedule - Schedule
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"from": ISO8601DateTime,
"id": 4,
"photo": "xyz789",
"schedule": Schedule,
"timezone": "xyz789",
"to": ISO8601DateTime,
"workspace": Workspace
}
SchedulePhotoConnection
Description
The connection type for SchedulePhoto.
Fields
| Field Name | Description |
|---|---|
edges - [SchedulePhotoEdge]
|
A list of edges. |
nodes - [SchedulePhoto]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [SchedulePhotoEdge],
"nodes": [SchedulePhoto],
"pageInfo": PageInfo,
"totalCount": 987
}
SchedulePhotoEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - SchedulePhoto
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": SchedulePhoto
}
SchedulePhotoFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime
|
|
scheduleId - ID
|
|
toTime - ISO8601DateTime
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleId": 4,
"toTime": ISO8601DateTime
}
ScheduleUser
ScheduledActualPerDay
Fields
| Field Name | Description |
|---|---|
actual - Minute!
|
|
date - ISO8601DateTime!
|
|
scheduled - Minute!
|
Example
{
"actual": Minute,
"date": ISO8601DateTime,
"scheduled": Minute
}
ScheduledActualReportFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime!
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime!
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleIds": ["4"],
"toTime": ISO8601DateTime
}
ScheduledActualResponse
Fields
| Field Name | Description |
|---|---|
days - [ScheduledActualPerDay!]!
|
|
user - User
|
Example
{
"days": [ScheduledActualPerDay],
"user": User
}
ScheduledStaffingReportFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime!
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime!
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleIds": ["4"],
"toTime": ISO8601DateTime
}
SchedulesUserInput
Shift
Fields
| Field Name | Description |
|---|---|
approvedTargetedShiftSwapRequests - [ShiftSwapRequest!]!
|
|
assignee - User
|
|
attachments - [ShiftAttachment!]
|
|
breakDuration - Minute!
|
|
checklistAssignments - [ChecklistAssignment!]
|
|
client - Client
|
|
color - String
|
|
endTime - ISO8601DateTime!
|
|
endType - ShiftEndTypeEnum
|
|
group - Group
|
|
id - ID!
|
|
jobSite - JobSite
|
|
note - String
|
|
recurrence - Recurrence
|
|
requester - User!
|
|
requireClaimApproval - Boolean!
|
|
schedule - Schedule!
|
|
shiftBatchId - ID
|
|
shiftClaimRequests - [ShiftClaimRequest!]!
|
|
shiftPartners - [Shift!]
|
|
shiftRequests - [ShiftRequest!]!
|
|
startTime - ISO8601DateTime!
|
|
state - ShiftStateEnum!
|
|
systemNote - String
|
|
timeCard - TimeCard
|
|
timezone - String!
|
|
title - String
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"approvedTargetedShiftSwapRequests": [ShiftSwapRequest],
"assignee": User,
"attachments": [ShiftAttachment],
"breakDuration": Minute,
"checklistAssignments": [ChecklistAssignment],
"client": Client,
"color": "xyz789",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"group": Group,
"id": "4",
"jobSite": JobSite,
"note": "xyz789",
"recurrence": Recurrence,
"requester": User,
"requireClaimApproval": true,
"schedule": Schedule,
"shiftBatchId": 4,
"shiftClaimRequests": [ShiftClaimRequest],
"shiftPartners": [Shift],
"shiftRequests": [ShiftRequest],
"startTime": ISO8601DateTime,
"state": "ABSENT",
"systemNote": "xyz789",
"timeCard": TimeCard,
"timezone": "xyz789",
"title": "abc123",
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
ShiftAttachment
Fields
| Field Name | Description |
|---|---|
attachment - String
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
jobSiteAttachment - JobSiteAttachment
|
|
shiftId - ID!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"attachment": "abc123",
"createdAt": ISO8601DateTime,
"id": "4",
"jobSiteAttachment": JobSiteAttachment,
"shiftId": 4,
"updatedAt": ISO8601DateTime
}
ShiftAttachmentInput
ShiftBatch
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
requester - User!
|
|
shifts - [Shift!]
|
|
workspace - Workspace!
|
Example
{
"id": 4,
"requester": User,
"shifts": [Shift],
"workspace": Workspace
}
ShiftBatchAssigneeInput
ShiftClaimRequest
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
requester - User!
|
|
shift - Shift!
|
|
state - ShiftClaimRequestStateEnum!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"requester": User,
"shift": Shift,
"state": "APPROVED"
}
ShiftClaimRequestConnection
Description
The connection type for ShiftClaimRequest.
Fields
| Field Name | Description |
|---|---|
edges - [ShiftClaimRequestEdge]
|
A list of edges. |
nodes - [ShiftClaimRequest]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [ShiftClaimRequestEdge],
"nodes": [ShiftClaimRequest],
"pageInfo": PageInfo,
"totalCount": 987
}
ShiftClaimRequestEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ShiftClaimRequest
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": ShiftClaimRequest
}
ShiftClaimRequestFilter
Fields
| Input Field | Description |
|---|---|
_or - [ShiftClaimRequestFilter!]
|
|
requesterIds - [ID!]
|
|
scheduleIds - [ID!]
|
|
shiftClaimRequestStates - [ShiftClaimRequestStateEnum!]
|
Example
{
"_or": [ShiftClaimRequestFilter],
"requesterIds": ["4"],
"scheduleIds": ["4"],
"shiftClaimRequestStates": ["APPROVED"]
}
ShiftClaimRequestStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
ShiftConnection
Description
The connection type for Shift.
Fields
| Field Name | Description |
|---|---|
edges - [ShiftEdge]
|
A list of edges. |
nodes - [Shift]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [ShiftEdge],
"nodes": [Shift],
"pageInfo": PageInfo,
"totalCount": 123
}
ShiftEdge
ShiftEndTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BUSINESS_DECLINE"
ShiftEndTypeInputEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BUSINESS_DECLINE"
ShiftFilter
Fields
| Input Field | Description |
|---|---|
_or - [ShiftFilter!]
|
|
fromTime - ISO8601DateTime
|
|
groupIds - [ID!]
|
|
scheduleIds - [ID!]
|
|
shiftStates - [ShiftStateEnum!]
|
|
toTime - ISO8601DateTime
|
|
userIds - [ID!]
|
Example
{
"_or": [ShiftFilter],
"fromTime": ISO8601DateTime,
"groupIds": [4],
"scheduleIds": [4],
"shiftStates": ["ABSENT"],
"toTime": ISO8601DateTime,
"userIds": [4]
}
ShiftOffer
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
requester - User!
|
|
shift - Shift!
|
|
shiftOfferRequests - [ShiftOfferRequest!]!
|
|
state - ShiftRequestStateEnum!
|
|
workspace - Workspace!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"requester": User,
"shift": Shift,
"shiftOfferRequests": [ShiftOfferRequest],
"state": "ACCEPTED",
"workspace": Workspace
}
ShiftOfferRequest
Fields
| Field Name | Description |
|---|---|
acceptedAt - ISO8601DateTime
|
|
approvedAt - ISO8601DateTime
|
|
approver - User
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
receiver - User!
|
|
refusedAt - ISO8601DateTime
|
|
rejectedAt - ISO8601DateTime
|
|
shiftOffer - ShiftOffer!
|
|
state - ShiftRequestStateEnum!
|
|
workspace - Workspace!
|
Example
{
"acceptedAt": ISO8601DateTime,
"approvedAt": ISO8601DateTime,
"approver": User,
"createdAt": ISO8601DateTime,
"id": "4",
"receiver": User,
"refusedAt": ISO8601DateTime,
"rejectedAt": ISO8601DateTime,
"shiftOffer": ShiftOffer,
"state": "ACCEPTED",
"workspace": Workspace
}
ShiftRequest
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
requester - User!
|
|
shift - Shift!
|
|
shiftOfferRequests - [ShiftOfferRequest!]!
|
|
shiftSwapRequests - [ShiftSwapRequest!]!
|
|
state - ShiftRequestStateEnum!
|
|
type - ShiftRequestTypeEnum!
|
|
workspace - Workspace!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"requester": User,
"shift": Shift,
"shiftOfferRequests": [ShiftOfferRequest],
"shiftSwapRequests": [ShiftSwapRequest],
"state": "ACCEPTED",
"type": "SHIFT_OFFER",
"workspace": Workspace
}
ShiftRequestConnection
Description
The connection type for ShiftRequest.
Fields
| Field Name | Description |
|---|---|
edges - [ShiftRequestEdge]
|
A list of edges. |
nodes - [ShiftRequest]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [ShiftRequestEdge],
"nodes": [ShiftRequest],
"pageInfo": PageInfo,
"totalCount": 123
}
ShiftRequestEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ShiftRequest
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ShiftRequest
}
ShiftRequestFilter
Fields
| Input Field | Description |
|---|---|
_or - [ShiftRequestFilter!]
|
|
approverIds - [ID!]
|
|
creatorIds - [ID!]
|
|
excludeSelfCreated - Boolean
|
|
receiverIds - [ID!]
|
|
scheduleIds - [ID!]
|
|
shiftRequestStates - [ShiftRequestStateEnum!]
|
Example
{
"_or": [ShiftRequestFilter],
"approverIds": ["4"],
"creatorIds": ["4"],
"excludeSelfCreated": false,
"receiverIds": ["4"],
"scheduleIds": [4],
"shiftRequestStates": ["ACCEPTED"]
}
ShiftRequestStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
ShiftRequestTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SHIFT_OFFER"
ShiftStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ABSENT"
ShiftSwap
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
requester - User!
|
|
shift - Shift!
|
|
shiftSwapRequests - [ShiftSwapRequest!]!
|
|
state - ShiftRequestStateEnum!
|
|
workspace - Workspace!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"requester": User,
"shift": Shift,
"shiftSwapRequests": [ShiftSwapRequest],
"state": "ACCEPTED",
"workspace": Workspace
}
ShiftSwapRequest
Fields
| Field Name | Description |
|---|---|
acceptedAt - ISO8601DateTime
|
|
approvedAt - ISO8601DateTime
|
|
approver - User
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
receiver - User!
|
|
refusedAt - ISO8601DateTime
|
|
rejectedAt - ISO8601DateTime
|
|
shiftSwap - ShiftSwap!
|
|
state - ShiftRequestStateEnum!
|
|
targetShift - Shift!
|
|
workspace - Workspace!
|
Example
{
"acceptedAt": ISO8601DateTime,
"approvedAt": ISO8601DateTime,
"approver": User,
"createdAt": ISO8601DateTime,
"id": 4,
"receiver": User,
"refusedAt": ISO8601DateTime,
"rejectedAt": ISO8601DateTime,
"shiftSwap": ShiftSwap,
"state": "ACCEPTED",
"targetShift": Shift,
"workspace": Workspace
}
ShiftTemplate
Fields
| Field Name | Description |
|---|---|
breakDuration - Minute!
|
|
endTime - ISO8601DateTime!
|
|
endType - ShiftEndTypeEnum
|
|
group - Group
|
|
id - ID!
|
|
jobSite - JobSite
|
|
name - String
|
|
note - String
|
|
schedule - Schedule
|
|
startTime - ISO8601DateTime!
|
|
timezone - String!
|
Example
{
"breakDuration": Minute,
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"group": Group,
"id": 4,
"jobSite": JobSite,
"name": "xyz789",
"note": "xyz789",
"schedule": Schedule,
"startTime": ISO8601DateTime,
"timezone": "abc123"
}
ShiftTemplateFilter
Fields
| Input Field | Description |
|---|---|
_or - [ShiftTemplateFilter!]
|
|
employeeId - ID
|
|
scheduleIds - [ID!]
|
Example
{
"_or": [ShiftTemplateFilter],
"employeeId": 4,
"scheduleIds": ["4"]
}
SignUpInput
Description
Autogenerated input type of SignUp
Example
{
"businessName": "xyz789",
"clientMutationId": "xyz789",
"fullName": "xyz789",
"phoneNumber": "abc123",
"timezone": "xyz789",
"workEmail": "abc123"
}
SignUpPayload
Description
Autogenerated return type of SignUp
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - SignupProspectResult
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": SignupProspectResult
}
SignupProspectResult
SignupWorkspaceInput
Description
Autogenerated input type of SignupWorkspace
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
owner - OwnerInfoInput!
|
|
platform - PlatformEnum
|
|
workspace - WorkspaceInfoInput!
|
Example
{
"clientMutationId": "xyz789",
"owner": OwnerInfoInput,
"platform": "MOBILE",
"workspace": WorkspaceInfoInput
}
SignupWorkspacePayload
Description
Autogenerated return type of SignupWorkspace
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - SignupWorkspaceResult
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": SignupWorkspaceResult
}
SignupWorkspaceResult
Fields
| Field Name | Description |
|---|---|
jwtPayload - JwtPayload!
|
|
workspace - Workspace!
|
Example
{
"jwtPayload": JwtPayload,
"workspace": Workspace
}
StartTaskInput
StartTaskPayload
Description
Autogenerated return type of StartTask
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Task
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Task
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubmitDraftLeaveInput
SubmitDraftLeavePayload
Description
Autogenerated return type of SubmitDraftLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
SubmitDraftTimesheetInput
SubmitDraftTimesheetPayload
Description
Autogenerated return type of SubmitDraftTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
SubmitDraftTimesheetsInput
SubmitDraftTimesheetsPayload
Description
Autogenerated return type of SubmitDraftTimesheets
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Timesheet!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [Timesheet]
}
SubmitLeaveInput
Description
Autogenerated input type of SubmitLeave
Fields
| Input Field | Description |
|---|---|
allDay - Boolean!
|
|
approverId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
days - [LeaveDayInput!]!
|
|
employeeId - ID!
|
|
from - ISO8601DateTime!
|
|
leaveCategoryId - ID!
|
|
paid - Boolean
|
|
reason - String
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
Example
{
"allDay": true,
"approverId": "4",
"clientMutationId": "xyz789",
"days": [LeaveDayInput],
"employeeId": "4",
"from": ISO8601DateTime,
"leaveCategoryId": "4",
"paid": false,
"reason": "xyz789",
"timezone": "abc123",
"to": ISO8601DateTime
}
SubmitLeavePayload
Description
Autogenerated return type of SubmitLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
SubmitTimesheetInput
Description
Autogenerated input type of SubmitTimesheet
Fields
| Input Field | Description |
|---|---|
breaks - [TimesheetBreakInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
employeeId - ID!
|
|
from - ISO8601DateTime!
|
|
groupId - ID
|
|
scheduleId - ID
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
Example
{
"breaks": [TimesheetBreakInput],
"clientMutationId": "xyz789",
"employeeId": 4,
"from": ISO8601DateTime,
"groupId": "4",
"scheduleId": 4,
"timezone": "abc123",
"to": ISO8601DateTime
}
SubmitTimesheetPayload
Description
Autogenerated return type of SubmitTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
SubscriptionBillingModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FLEXI"
SubscriptionItem
Fields
| Field Name | Description |
|---|---|
addons - [WorkspaceFeatureEnum!]!
|
|
billingMode - SubscriptionBillingModeEnum!
|
|
features - [WorkspaceFeatureEnum!]!
|
|
id - ID!
|
|
quantity - Int!
|
|
subscriptionPlan - SubscriptionPlan!
|
|
subscriptionPlanPrice - SubscriptionPlanPrice!
|
Example
{
"addons": ["ADVANCED_SCHEDULING"],
"billingMode": "FLEXI",
"features": ["ADVANCED_SCHEDULING"],
"id": "4",
"quantity": 987,
"subscriptionPlan": SubscriptionPlan,
"subscriptionPlanPrice": SubscriptionPlanPrice
}
SubscriptionModel
Fields
| Field Name | Description |
|---|---|
features - [WorkspaceFeatureEnum!]
|
Use features + addons in subscription_items. From 1.1.18 |
id - ID!
|
|
state - SubscriptionStateEnum!
|
|
subscriptionItems - [SubscriptionItem!]!
|
|
subscriptionPlans - [SubscriptionPlan!]
|
subscription_items. From 1.1.18 |
trialEndAt - ISO8601DateTime
|
Example
{
"features": ["ADVANCED_SCHEDULING"],
"id": 4,
"state": "ACTIVE",
"subscriptionItems": [SubscriptionItem],
"subscriptionPlans": [SubscriptionPlan],
"trialEndAt": ISO8601DateTime
}
SubscriptionPlan
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
features - [WorkspaceFeatureEnum!]
|
|
id - ID!
|
|
name - String!
|
Example
{
"code": "xyz789",
"features": ["ADVANCED_SCHEDULING"],
"id": "4",
"name": "abc123"
}
SubscriptionPlanPrice
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
interval - PlanIntervalEnum!
|
|
intervalCount - Int!
|
|
unitAmount - Int!
|
|
usageType - SubscriptionUsageTypeEnum!
|
Example
{
"id": 4,
"interval": "DAY",
"intervalCount": 987,
"unitAmount": 123,
"usageType": "LICENSED"
}
SubscriptionStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
SubscriptionUsageTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LICENSED"
SupportedServiceEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"KIOSK"
SurveyAnswerInput
SwapShiftInput
SwapShiftPayload
Description
Autogenerated return type of SwapShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
SyncTimeCardPunchAttachmentInput
Description
Autogenerated input type of SyncTimeCardPunchAttachment
Fields
| Input Field | Description |
|---|---|
atTime - ISO8601DateTime!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
photoKey - String!
|
|
timeCardId - ID!
|
Example
{
"atTime": ISO8601DateTime,
"clientMutationId": "abc123",
"photoKey": "abc123",
"timeCardId": 4
}
SyncTimeCardPunchAttachmentPayload
Description
Autogenerated return type of SyncTimeCardPunchAttachment
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - TimeCardPunchAttachment
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": TimeCardPunchAttachment
}
SyncTimeCardPunchesInput
Description
Autogenerated input type of SyncTimeCardPunches
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
punches - [TimeCardPunchInput!]!
|
Punches sorted ascending in timeline |
Example
{
"clientMutationId": "xyz789",
"punches": [TimeCardPunchInput]
}
SyncTimeCardPunchesPayload
Description
Autogenerated return type of SyncTimeCardPunches
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [TimeCardPunch!]
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": [TimeCardPunch]
}
Tag
Fields
| Field Name | Description |
|---|---|
color - String!
|
|
colorName - String!
|
|
createdAt - ISO8601DateTime!
|
|
default - Boolean
|
|
deletedAt - ISO8601DateTime
|
|
id - ID!
|
|
name - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"color": "xyz789",
"colorName": "xyz789",
"createdAt": ISO8601DateTime,
"default": false,
"deletedAt": ISO8601DateTime,
"id": "4",
"name": "xyz789",
"updatedAt": ISO8601DateTime
}
TagConnection
TagEdge
TagInput
Task
Fields
| Field Name | Description |
|---|---|
assignee - User
|
|
checklist - Checklist
|
|
code - String
|
|
comments - [Comment!]
|
|
completedLog - [CompletedLog!]
|
|
completionCountTarget - Int
|
|
description - String!
|
|
doneAt - ISO8601DateTime
|
|
dueDate - ISO8601DateTime
|
|
id - ID!
|
|
inProgressAt - ISO8601DateTime
|
|
lastCompletedAt - ISO8601DateTime
|
|
name - String!
|
|
notStartedAt - ISO8601DateTime
|
|
parent - Task
|
|
requester - User!
|
|
state - TaskStateEnum!
|
|
subTasks - [Task!]
|
|
workspace - Workspace!
|
Example
{
"assignee": User,
"checklist": Checklist,
"code": "abc123",
"comments": [Comment],
"completedLog": [CompletedLog],
"completionCountTarget": 987,
"description": "abc123",
"doneAt": ISO8601DateTime,
"dueDate": ISO8601DateTime,
"id": 4,
"inProgressAt": ISO8601DateTime,
"lastCompletedAt": ISO8601DateTime,
"name": "abc123",
"notStartedAt": ISO8601DateTime,
"parent": Task,
"requester": User,
"state": "DONE",
"subTasks": [Task],
"workspace": Workspace
}
TaskConnection
Description
The connection type for Task.
Fields
| Field Name | Description |
|---|---|
edges - [TaskEdge]
|
A list of edges. |
nodes - [Task]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [TaskEdge],
"nodes": [Task],
"pageInfo": PageInfo,
"totalCount": 987
}
TaskEdge
TaskFilter
Fields
| Input Field | Description |
|---|---|
_or - [TaskFilter!]
|
|
assigneeIds - [ID!]
|
|
fromTime - ISO8601DateTime
|
|
requesterIds - [ID!]
|
|
taskState - TaskStateEnum
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [TaskFilter],
"assigneeIds": [4],
"fromTime": ISO8601DateTime,
"requesterIds": [4],
"taskState": "DONE",
"toTime": ISO8601DateTime
}
TaskStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DONE"
ThisWeekSnapshot
ThisWeekSnapshotFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime
|
Example
{
"fromTime": ISO8601DateTime,
"scheduleIds": [4],
"toTime": ISO8601DateTime
}
TimeCard
Fields
| Field Name | Description |
|---|---|
autoDeductedUnpaidBreakDuration - Minute!
|
|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
endTime - ISO8601DateTime
|
|
group - Group
|
|
hasWarning - Boolean!
|
|
id - ID!
|
|
note - String
|
|
punches - [TimeCardPunch!]!
|
|
schedule - Schedule
|
|
shift - Shift
|
|
shiftId - ID
|
|
startTime - ISO8601DateTime
|
|
state - TimeCardStateEnum!
|
|
timezone - String!
|
|
totalDuration - Minute!
|
Example
{
"autoDeductedUnpaidBreakDuration": Minute,
"createdAt": ISO8601DateTime,
"creator": User,
"endTime": ISO8601DateTime,
"group": Group,
"hasWarning": false,
"id": 4,
"note": "abc123",
"punches": [TimeCardPunch],
"schedule": Schedule,
"shift": Shift,
"shiftId": 4,
"startTime": ISO8601DateTime,
"state": "CLOCKED_IN",
"timezone": "xyz789",
"totalDuration": Minute
}
TimeCardConnection
Description
The connection type for TimeCard.
Fields
| Field Name | Description |
|---|---|
edges - [TimeCardEdge]
|
A list of edges. |
nodes - [TimeCard]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [TimeCardEdge],
"nodes": [TimeCard],
"pageInfo": PageInfo,
"totalCount": 123
}
TimeCardEdge
TimeCardFilter
Fields
| Input Field | Description |
|---|---|
_or - [TimeCardFilter!]
|
|
date - ISO8601DateTime
|
|
timeCardStates - [TimeCardStateEnum!]
|
|
unscheduled - Boolean
|
|
userIds - [ID!]
|
Example
{
"_or": [TimeCardFilter],
"date": ISO8601DateTime,
"timeCardStates": ["CLOCKED_IN"],
"unscheduled": true,
"userIds": ["4"]
}
TimeCardPunch
Fields
| Field Name | Description |
|---|---|
atTime - ISO8601DateTime!
|
|
attachment - TimeCardPunchAttachment
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
note - String
|
|
punchType - TimeCardPunchTypeEnum!
|
|
timeCardId - ID!
|
|
updatedAt - ISO8601DateTime!
|
|
warnings - [TimeCardPunchWarning!]
|
Example
{
"atTime": ISO8601DateTime,
"attachment": TimeCardPunchAttachment,
"createdAt": ISO8601DateTime,
"id": "4",
"note": "xyz789",
"punchType": "CLOCK_IN",
"timeCardId": "4",
"updatedAt": ISO8601DateTime,
"warnings": [TimeCardPunchWarning]
}
TimeCardPunchAttachment
Fields
| Field Name | Description |
|---|---|
atTime - ISO8601DateTime!
|
|
createdAt - ISO8601DateTime!
|
|
geoLat - Float
|
|
geoLong - Float
|
|
id - ID!
|
|
photo - String
|
|
photoToken - String
|
|
timeCardId - ID!
|
|
updatedAt - ISO8601DateTime!
|
|
wifiBssid - String
|
|
wifiSsid - String
|
Example
{
"atTime": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"geoLat": 123.45,
"geoLong": 123.45,
"id": "4",
"photo": "xyz789",
"photoToken": "abc123",
"timeCardId": 4,
"updatedAt": ISO8601DateTime,
"wifiBssid": "abc123",
"wifiSsid": "xyz789"
}
TimeCardPunchAttachmentInput
TimeCardPunchInput
Fields
| Input Field | Description |
|---|---|
atTime - ISO8601DateTime!
|
|
attachment - TimeCardPunchAttachmentInput
|
|
note - String
|
|
punchType - TimeCardPunchTypeEnum!
|
|
timeCardId - ID!
|
Example
{
"atTime": ISO8601DateTime,
"attachment": TimeCardPunchAttachmentInput,
"note": "xyz789",
"punchType": "CLOCK_IN",
"timeCardId": "4"
}
TimeCardPunchTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLOCK_IN"
TimeCardPunchWarning
Fields
| Field Name | Description |
|---|---|
type - TimeCardPunchWarningTypeEnum!
|
|
value - Int!
|
Example
{"type": "EARLY_CLOCKED_IN", "value": 123}
TimeCardPunchWarningTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EARLY_CLOCKED_IN"
TimeCardStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOCKED_IN"
Timesheet
Fields
| Field Name | Description |
|---|---|
approvedAt - ISO8601DateTime
|
|
approver - User
|
|
comments - Int
|
|
creator - User!
|
|
draftAt - ISO8601DateTime!
|
|
employee - User!
|
|
from - ISO8601DateTime!
|
|
group - Group
|
|
id - ID!
|
|
processedAt - ISO8601DateTime
|
|
referenceObject - ReferenceObject
|
|
rejectedAt - ISO8601DateTime
|
|
schedule - Schedule
|
|
state - TimesheetStateEnum!
|
|
submittedAt - ISO8601DateTime
|
|
timezone - String!
|
|
to - ISO8601DateTime!
|
|
totalDuration - Minute!
|
|
unpaidBreaks - [TimesheetUnpaidBreak!]!
|
|
updatedAt - ISO8601DateTime!
|
|
workspace - Workspace!
|
Example
{
"approvedAt": ISO8601DateTime,
"approver": User,
"comments": 123,
"creator": User,
"draftAt": ISO8601DateTime,
"employee": User,
"from": ISO8601DateTime,
"group": Group,
"id": "4",
"processedAt": ISO8601DateTime,
"referenceObject": Document,
"rejectedAt": ISO8601DateTime,
"schedule": Schedule,
"state": "APPROVED",
"submittedAt": ISO8601DateTime,
"timezone": "abc123",
"to": ISO8601DateTime,
"totalDuration": Minute,
"unpaidBreaks": [TimesheetAutoDeductBreak],
"updatedAt": ISO8601DateTime,
"workspace": Workspace
}
TimesheetAutoDeductBreak
TimesheetBreakInput
TimesheetConnection
Description
The connection type for Timesheet.
Fields
| Field Name | Description |
|---|---|
edges - [TimesheetEdge]
|
A list of edges. |
nodes - [Timesheet]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [TimesheetEdge],
"nodes": [Timesheet],
"pageInfo": PageInfo,
"totalCount": 123
}
TimesheetEdge
TimesheetFilter
Fields
| Input Field | Description |
|---|---|
_or - [TimesheetFilter!]
|
|
approverIds - [ID!]
|
|
creatorIds - [ID!]
|
|
employeeIds - [ID!]
|
|
fromTime - ISO8601DateTime
|
|
groupIds - [ID!]
|
|
referenceObjectTypes - [TimesheetFilterReferenceObject!]
|
|
scheduleIds - [ID!]
|
|
timesheetStates - [TimesheetStateEnum!]
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [TimesheetFilter],
"approverIds": ["4"],
"creatorIds": [4],
"employeeIds": ["4"],
"fromTime": ISO8601DateTime,
"groupIds": ["4"],
"referenceObjectTypes": ["LEAVE_REQUEST"],
"scheduleIds": ["4"],
"timesheetStates": ["APPROVED"],
"toTime": ISO8601DateTime
}
TimesheetFilterReferenceObject
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LEAVE_REQUEST"
TimesheetManualBreak
TimesheetOrder
Fields
| Input Field | Description |
|---|---|
column - TimesheetOrderColumnsEnum!
|
|
direction - OrderOrientEnum!
|
Example
{"column": "FROM", "direction": "ASC"}
TimesheetOrderColumnsEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FROM"
TimesheetPunchBreak
Fields
| Field Name | Description |
|---|---|
data - TimesheetPunchBreakData!
|
|
duration - Minute!
|
|
id - ID!
|
|
note - String
|
Example
{
"data": TimesheetPunchBreakData,
"duration": Minute,
"id": "4",
"note": "abc123"
}
TimesheetPunchBreakData
Fields
| Field Name | Description |
|---|---|
inPunchTime - ISO8601DateTime!
|
|
outPunchTime - ISO8601DateTime!
|
Example
{
"inPunchTime": ISO8601DateTime,
"outPunchTime": ISO8601DateTime
}
TimesheetReportFilter
Fields
| Input Field | Description |
|---|---|
_or - [TimesheetReportFilter!]
|
|
fromTime - ISO8601DateTime
|
|
scheduleIds - [ID!]
|
|
toTime - ISO8601DateTime
|
Example
{
"_or": [TimesheetReportFilter],
"fromTime": ISO8601DateTime,
"scheduleIds": [4],
"toTime": ISO8601DateTime
}
TimesheetReportResult
TimesheetRoundBreakTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOSER"
TimesheetRoundTimeTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLOSER"
TimesheetStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"APPROVED"
TimesheetSummaryFilter
Fields
| Input Field | Description |
|---|---|
fromTime - ISO8601DateTime
|
|
groupIds - [ID!]
|
|
scheduleIds - [ID!]
|
|
timesheetStates - [TimesheetStateEnum!]
|
|
toTime - ISO8601DateTime
|
Example
{
"fromTime": ISO8601DateTime,
"groupIds": ["4"],
"scheduleIds": [4],
"timesheetStates": ["APPROVED"],
"toTime": ISO8601DateTime
}
TimesheetSummaryResponse
Example
{
"doubleOvertime": Minute,
"overtime": Minute,
"regular": Minute,
"timeOff": Minute,
"total": Minute,
"totalApproved": Minute,
"totalScheduled": Minute,
"user": User
}
TimesheetUnpaidBreak
Description
Properties of TimesheetBreak
Types
| Union Types |
|---|
Example
TimesheetAutoDeductBreak
TodaySnapshot
Example
{
"checklistAssignments": TodaySnapshotChecklistAssignment,
"currentlyClockedIn": 123,
"currentlyLate": 987,
"currentlyOnBreak": 987,
"id": 4,
"timeOffs": 123
}
TodaySnapshotChecklistAssignment
TodaySnapshotFilter
Fields
| Input Field | Description |
|---|---|
scheduleIds - [ID!]
|
Example
{"scheduleIds": [4]}
ToggleReactionInput
ToggleReactionPayload
Description
Autogenerated return type of ToggleReaction
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatMessage
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatMessage
}
UnacknowledgeDocumentInput
UnacknowledgeDocumentPayload
Description
Autogenerated return type of UnacknowledgeDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
UnarchiveChannelInput
UnarchiveChannelPayload
Description
Autogenerated return type of UnarchiveChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatChannel
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": ChatChannel
}
UnarchiveMemberInput
UnarchiveMemberPayload
Description
Autogenerated return type of UnarchiveMember
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - String
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": "abc123"
}
UnconfirmMessageBoardPostInput
UnconfirmMessageBoardPostPayload
Description
Autogenerated return type of UnconfirmMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
UndoFinishTaskInput
UndoFinishTaskPayload
Description
Autogenerated return type of UndoFinishTask
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Task
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Task
}
UnlinkUserFromDeviceInput
UnlinkUserFromDevicePayload
Description
Autogenerated return type of UnlinkUserFromDevice
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Boolean
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": false
}
UnpinDocumentInput
UnpinDocumentPayload
Description
Autogenerated return type of UnpinDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
UnpinMessageBoardInput
UnpinMessageBoardPayload
Description
Autogenerated return type of UnpinMessageBoard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoard
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoard
}
UnpinMessageBoardPostInput
UnpinMessageBoardPostPayload
Description
Autogenerated return type of UnpinMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
UpdateAvailabilityInput
Description
Autogenerated input type of UpdateAvailability
Fields
| Input Field | Description |
|---|---|
allDay - Boolean
|
|
availabilityId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
from - ISO8601DateTime
|
|
note - String
|
|
recurrenceEditType - RecurrenceEditTypeEnum
|
|
recurrenceRule - String
|
|
timezone - String
|
|
to - ISO8601DateTime
|
|
type - AvailabilityTypeEnum
|
Example
{
"allDay": true,
"availabilityId": 4,
"clientMutationId": "xyz789",
"from": ISO8601DateTime,
"note": "xyz789",
"recurrenceEditType": "ALL",
"recurrenceRule": "abc123",
"timezone": "xyz789",
"to": ISO8601DateTime,
"type": "PREFERRED_WORKING_TIME"
}
UpdateAvailabilityPayload
Description
Autogenerated return type of UpdateAvailability
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Availability
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Availability
}
UpdateCalendarEventInput
Description
Autogenerated input type of UpdateCalendarEvent
Fields
| Input Field | Description |
|---|---|
allDay - Boolean
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventType - CalendarEventTypeEnum
|
|
from - ISO8601DateTime
|
|
id - ID!
|
|
note - String
|
|
recurrenceEditType - RecurrenceEditTypeEnum
|
|
recurrenceRule - String
|
|
scheduleIds - [ID!]
|
|
state - CalendarEventStateEnum
|
|
timezone - String
|
|
to - ISO8601DateTime
|
Example
{
"allDay": true,
"clientMutationId": "xyz789",
"eventType": "CLOSED_BUSINESS",
"from": ISO8601DateTime,
"id": 4,
"note": "xyz789",
"recurrenceEditType": "ALL",
"recurrenceRule": "abc123",
"scheduleIds": ["4"],
"state": "ACTIVE",
"timezone": "xyz789",
"to": ISO8601DateTime
}
UpdateCalendarEventPayload
Description
Autogenerated return type of UpdateCalendarEvent
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - CalendarEvent
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": CalendarEvent
}
UpdateChannelInput
Description
Autogenerated input type of UpdateChannel
Example
{
"channelId": 4,
"channelType": "DIRECT",
"clientMutationId": "xyz789",
"color": "xyz789",
"displayName": "xyz789",
"emojiIcon": "xyz789",
"purpose": "abc123",
"sticky": true,
"userIds": ["4"]
}
UpdateChannelMemberInput
Description
Autogenerated input type of UpdateChannelMember
Fields
| Input Field | Description |
|---|---|
channelMemberId - ID!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
muted - Boolean
|
|
notification - ChannelMemberNotificationEnum
|
|
role - ChannelMemberRoleEnum
|
Example
{
"channelMemberId": "4",
"clientMutationId": "xyz789",
"muted": true,
"notification": "ALL",
"role": "ADMIN"
}
UpdateChannelMemberPayload
Description
Autogenerated return type of UpdateChannelMember
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChannelMember
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChannelMember
}
UpdateChannelPayload
Description
Autogenerated return type of UpdateChannel
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ChatChannel
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ChatChannel
}
UpdateCommentInput
UpdateCommentPayload
Description
Autogenerated return type of UpdateComment
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Comment
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Comment
}
UpdateDocumentInput
Description
Autogenerated input type of UpdateDocument
Fields
| Input Field | Description |
|---|---|
acknowledgementRequired - Boolean
|
|
allUsersAssigned - Boolean
|
|
assignedGroupIds - [ID!]
|
|
assigneeIds - [ID!]
|
|
assignmentType - DocumentAssignmentEnum
|
|
attachments - [DocumentAttachmentInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
documentId - ID!
|
|
expiredAt - ISO8601DateTime
|
|
folderId - ID
|
|
name - String
|
|
notes - String
|
|
saveAsDraft - Boolean
|
|
shareWithNewHires - Boolean
|
|
tags - [TagInput!]
|
Example
{
"acknowledgementRequired": true,
"allUsersAssigned": true,
"assignedGroupIds": ["4"],
"assigneeIds": [4],
"assignmentType": "PERSONAL",
"attachments": [DocumentAttachmentInput],
"clientMutationId": "xyz789",
"color": "xyz789",
"documentId": "4",
"expiredAt": ISO8601DateTime,
"folderId": "4",
"name": "xyz789",
"notes": "abc123",
"saveAsDraft": false,
"shareWithNewHires": false,
"tags": [TagInput]
}
UpdateDocumentPayload
Description
Autogenerated return type of UpdateDocument
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Document
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Document
}
UpdateFolderInput
Description
Autogenerated input type of UpdateFolder
Example
{
"clientMutationId": "xyz789",
"description": "abc123",
"documentIds": [4],
"folderId": "4",
"name": "xyz789",
"parentId": 4,
"private": false
}
UpdateFolderPayload
Description
Autogenerated return type of UpdateFolder
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Folder
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Folder
}
UpdateGroupInput
Description
Autogenerated input type of UpdateGroup
Example
{
"clientMutationId": "xyz789",
"color": "xyz789",
"groupId": 4,
"name": "abc123",
"userIds": ["4"]
}
UpdateGroupPayload
Description
Autogenerated return type of UpdateGroup
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Group
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Group
}
UpdateJobSiteInput
Description
Autogenerated input type of UpdateJobSite
Fields
| Input Field | Description |
|---|---|
address - String
|
|
attachments - [JobSiteAttachmentInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
geoLat - Float
|
|
geoLong - Float
|
|
jobSiteId - ID!
|
|
name - String
|
|
note - String
|
|
payRate - JobSitePayRateInput
|
|
scheduleIds - [ID!]
|
|
wifiBssid - String
|
|
wifiSsid - String
|
Example
{
"address": "xyz789",
"attachments": [JobSiteAttachmentInput],
"clientMutationId": "xyz789",
"color": "xyz789",
"geoLat": 123.45,
"geoLong": 123.45,
"jobSiteId": 4,
"name": "abc123",
"note": "abc123",
"payRate": JobSitePayRateInput,
"scheduleIds": [4],
"wifiBssid": "abc123",
"wifiSsid": "xyz789"
}
UpdateJobSitePayload
Description
Autogenerated return type of UpdateJobSite
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JobSite
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JobSite
}
UpdateJoinCodeInput
UpdateJoinCodePayload
Description
Autogenerated return type of UpdateJoinCode
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JoinCode
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JoinCode
}
UpdateLeaveCategoriesInput
Description
Autogenerated input type of UpdateLeaveCategories
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
leaveCategoriesInput - [LeaveCategoryInput!]!
|
Example
{
"clientMutationId": "abc123",
"leaveCategoriesInput": [LeaveCategoryInput]
}
UpdateLeaveCategoriesPayload
Description
Autogenerated return type of UpdateLeaveCategories
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [LeaveCategory!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [LeaveCategory]
}
UpdateLeaveInput
Description
Autogenerated input type of UpdateLeave
Fields
| Input Field | Description |
|---|---|
allDay - Boolean
|
|
approverId - ID
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
days - [LeaveDayInput!]
|
|
employeeId - ID
|
|
from - ISO8601DateTime
|
|
leaveCategoryId - ID
|
|
leaveId - String!
|
|
paid - Boolean
|
|
reason - String
|
|
timezone - String
|
|
to - ISO8601DateTime
|
Example
{
"allDay": true,
"approverId": 4,
"clientMutationId": "abc123",
"days": [LeaveDayInput],
"employeeId": 4,
"from": ISO8601DateTime,
"leaveCategoryId": "4",
"leaveId": "abc123",
"paid": false,
"reason": "abc123",
"timezone": "abc123",
"to": ISO8601DateTime
}
UpdateLeavePayload
Description
Autogenerated return type of UpdateLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
UpdateMembershipSettingsInput
Description
Autogenerated input type of UpdateMembershipSettings
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
emailLeaveRequest - Boolean
|
|
emailManageAvailabilityRequest - Boolean
|
|
emailManageDocument - Boolean
|
|
emailManageLeaveRequest - Boolean
|
|
emailManageMessageBoard - Boolean
|
|
emailManageShiftOfferRequest - Boolean
|
|
emailManageShiftSwapRequest - Boolean
|
|
emailManageTimesheet - Boolean
|
|
emailSchedulePosted - Boolean
|
|
emailShiftOfferRequest - Boolean
|
|
emailShiftReminder - Boolean
|
|
emailShiftSwapRequest - Boolean
|
|
emailSummary - Boolean
|
|
emailTimesheet - Boolean
|
|
maxDurationPerWeek - Minute
|
|
notificationShiftLate - Boolean
|
|
typicalWorkDuration - Minute
|
|
userId - ID!
|
Example
{
"clientMutationId": "xyz789",
"emailLeaveRequest": false,
"emailManageAvailabilityRequest": false,
"emailManageDocument": false,
"emailManageLeaveRequest": true,
"emailManageMessageBoard": true,
"emailManageShiftOfferRequest": true,
"emailManageShiftSwapRequest": true,
"emailManageTimesheet": false,
"emailSchedulePosted": true,
"emailShiftOfferRequest": false,
"emailShiftReminder": false,
"emailShiftSwapRequest": false,
"emailSummary": true,
"emailTimesheet": false,
"maxDurationPerWeek": Minute,
"notificationShiftLate": false,
"typicalWorkDuration": Minute,
"userId": "4"
}
UpdateMembershipSettingsPayload
Description
Autogenerated return type of UpdateMembershipSettings
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MembershipSetting
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MembershipSetting
}
UpdateMessageBoardInput
Description
Autogenerated input type of UpdateMessageBoard
Example
{
"allUsersAccessed": true,
"clientMutationId": "xyz789",
"description": "xyz789",
"memberIds": ["4"],
"messageBoardId": "4",
"messageBoardsMembers": [MessageBoardsMemberInput],
"name": "xyz789",
"shareWithNewHires": true
}
UpdateMessageBoardPayload
Description
Autogenerated return type of UpdateMessageBoard
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoard
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": MessageBoard
}
UpdateMessageBoardPostInput
Description
Autogenerated input type of UpdateMessageBoardPost
Fields
| Input Field | Description |
|---|---|
acknowledgementRequired - Boolean
|
|
blocks - JSON
|
|
categoryId - ID
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
commentEnabled - Boolean
|
|
content - String
|
|
images - [MessageBoardPostImageInput!]
|
|
messageBoardId - ID
|
|
messageBoardPostId - ID!
|
|
notifyAllMembers - Boolean
|
|
notifyUserIds - [ID!]
|
|
pinnedAt - ISO8601DateTime
|
|
saveAsDraft - Boolean
|
|
scheduledPostAt - ISO8601DateTime
|
|
title - String
|
Example
{
"acknowledgementRequired": true,
"blocks": {},
"categoryId": "4",
"clientMutationId": "abc123",
"commentEnabled": false,
"content": "abc123",
"images": [MessageBoardPostImageInput],
"messageBoardId": "4",
"messageBoardPostId": 4,
"notifyAllMembers": true,
"notifyUserIds": [4],
"pinnedAt": ISO8601DateTime,
"saveAsDraft": true,
"scheduledPostAt": ISO8601DateTime,
"title": "xyz789"
}
UpdateMessageBoardPostPayload
Description
Autogenerated return type of UpdateMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
UpdateReactionInput
UpdateReactionPayload
Description
Autogenerated return type of UpdateReaction
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Reaction
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Reaction
}
UpdateRoleInput
Description
Autogenerated input type of UpdateRole
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
roleId - ID!
|
|
users - [RoleUserInput!]!
|
Example
{
"clientMutationId": "xyz789",
"roleId": "4",
"users": [RoleUserInput]
}
UpdateRolePayload
Description
Autogenerated return type of UpdateRole
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Role
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Role
}
UpdateScheduleInput
Description
Autogenerated input type of UpdateSchedule
Example
{
"clientMutationId": "xyz789",
"defaultJobSiteId": 4,
"name": "abc123",
"scheduleId": 4,
"schedulesUsers": [SchedulesUserInput],
"timezone": "xyz789"
}
UpdateSchedulePayload
Description
Autogenerated return type of UpdateSchedule
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Schedule
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Schedule
}
UpdateSchedulePhotoInput
UpdateSchedulePhotoPayload
Description
Autogenerated return type of UpdateSchedulePhoto
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - SchedulePhoto
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": SchedulePhoto
}
UpdateShiftBatchInput
Description
Autogenerated input type of UpdateShiftBatch
Fields
| Input Field | Description |
|---|---|
assignees - [ShiftBatchAssigneeInput!]!
|
|
attachments - [ShiftAttachmentInput!]
|
|
breakDuration - Minute
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime
|
|
jobSiteId - ID
|
|
note - String
|
|
scheduleId - ID
|
|
shiftBatchId - ID!
|
|
startTime - ISO8601DateTime
|
|
timezone - String
|
|
title - String
|
Example
{
"assignees": [ShiftBatchAssigneeInput],
"attachments": [ShiftAttachmentInput],
"breakDuration": Minute,
"clientMutationId": "xyz789",
"color": "abc123",
"endTime": ISO8601DateTime,
"jobSiteId": 4,
"note": "abc123",
"scheduleId": "4",
"shiftBatchId": "4",
"startTime": ISO8601DateTime,
"timezone": "xyz789",
"title": "xyz789"
}
UpdateShiftBatchPayload
Description
Autogenerated return type of UpdateShiftBatch
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftBatch
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftBatch
}
UpdateShiftChecklistInput
Fields
| Input Field | Description |
|---|---|
_destroy - Boolean
|
|
checklistId - ID
|
|
name - String
|
|
tasks - [UpdateShiftTaskInput!]
|
Example
{
"_destroy": false,
"checklistId": "4",
"name": "xyz789",
"tasks": [UpdateShiftTaskInput]
}
UpdateShiftInput
Description
Autogenerated input type of UpdateShift
Fields
| Input Field | Description |
|---|---|
assigneeId - ID
|
|
attachments - [ShiftAttachmentInput!]
|
|
breakDuration - Minute
|
|
checklists - [UpdateShiftChecklistInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime
|
|
endType - ShiftEndTypeInputEnum
|
|
groupId - ID
|
|
jobSiteId - ID
|
|
note - String
|
|
recurrenceEditType - RecurrenceEditTypeEnum
|
|
recurrenceRule - String
|
|
requireClaimApproval - Boolean
|
|
scheduleId - ID
|
|
shiftId - ID!
|
|
startTime - ISO8601DateTime
|
|
timezone - String
|
|
title - String
|
Example
{
"assigneeId": 4,
"attachments": [ShiftAttachmentInput],
"breakDuration": Minute,
"checklists": [UpdateShiftChecklistInput],
"clientMutationId": "abc123",
"color": "abc123",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"groupId": 4,
"jobSiteId": 4,
"note": "xyz789",
"recurrenceEditType": "ALL",
"recurrenceRule": "abc123",
"requireClaimApproval": false,
"scheduleId": "4",
"shiftId": 4,
"startTime": ISO8601DateTime,
"timezone": "abc123",
"title": "xyz789"
}
UpdateShiftPayload
Description
Autogenerated return type of UpdateShift
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Shift
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Shift
}
UpdateShiftTaskInput
Fields
| Input Field | Description |
|---|---|
_destroy - Boolean
|
|
code - String
|
|
completionCountTarget - Int
|
|
description - String
|
|
dueDate - ISO8601DateTime
|
|
name - String
|
|
subTasks - [UpdateShiftTaskInput!]
|
|
taskId - ID
|
Example
{
"_destroy": true,
"code": "xyz789",
"completionCountTarget": 987,
"description": "abc123",
"dueDate": ISO8601DateTime,
"name": "abc123",
"subTasks": [UpdateShiftTaskInput],
"taskId": "4"
}
UpdateShiftTemplateInput
Description
Autogenerated input type of UpdateShiftTemplate
Fields
| Input Field | Description |
|---|---|
breakDuration - Minute
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
color - String
|
|
endTime - ISO8601DateTime
|
|
endType - ShiftEndTypeInputEnum
|
|
groupId - ID
|
|
jobSiteId - ID
|
|
name - String
|
|
note - String
|
|
scheduleId - ID
|
|
shiftTemplateId - ID!
|
|
startTime - ISO8601DateTime
|
|
timezone - String
|
Example
{
"breakDuration": Minute,
"clientMutationId": "abc123",
"color": "abc123",
"endTime": ISO8601DateTime,
"endType": "BUSINESS_DECLINE",
"groupId": "4",
"jobSiteId": 4,
"name": "abc123",
"note": "abc123",
"scheduleId": "4",
"shiftTemplateId": "4",
"startTime": ISO8601DateTime,
"timezone": "xyz789"
}
UpdateShiftTemplatePayload
Description
Autogenerated return type of UpdateShiftTemplate
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - ShiftTemplate
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": ShiftTemplate
}
UpdateTaskInput
Description
Autogenerated input type of UpdateTask
Example
{
"assigneeId": 4,
"clientMutationId": "xyz789",
"description": "xyz789",
"dueDate": ISO8601DateTime,
"name": "abc123",
"taskId": "4"
}
UpdateTaskPayload
Description
Autogenerated return type of UpdateTask
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Task
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Task
}
UpdateTimesheetInput
Description
Autogenerated input type of UpdateTimesheet
Fields
| Input Field | Description |
|---|---|
breaks - [TimesheetBreakInput!]
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
employeeId - ID
|
|
from - ISO8601DateTime
|
|
groupId - ID
|
|
scheduleId - ID
|
|
timesheetId - String!
|
|
timezone - String
|
|
to - ISO8601DateTime
|
Example
{
"breaks": [TimesheetBreakInput],
"clientMutationId": "xyz789",
"employeeId": "4",
"from": ISO8601DateTime,
"groupId": 4,
"scheduleId": 4,
"timesheetId": "abc123",
"timezone": "xyz789",
"to": ISO8601DateTime
}
UpdateTimesheetPayload
Description
Autogenerated return type of UpdateTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Timesheet
}
UpdateUserInput
Description
Autogenerated input type of UpdateUser
Fields
| Input Field | Description |
|---|---|
address - String
|
|
avatarKey - String
|
|
birthday - ISO8601DateTime
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
email - String
|
|
firstName - String
|
|
groupIds - [ID!]
|
|
language - String
|
|
lastName - String
|
|
phoneNumber - String
|
|
roles - [RoleCodeEnum!]
|
|
scheduleIds - [ID!]
|
|
timezone - String
|
|
userId - ID!
|
Example
{
"address": "abc123",
"avatarKey": "xyz789",
"birthday": ISO8601DateTime,
"clientMutationId": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"groupIds": ["4"],
"language": "abc123",
"lastName": "abc123",
"phoneNumber": "xyz789",
"roles": ["CONTRACTOR"],
"scheduleIds": ["4"],
"timezone": "abc123",
"userId": "4"
}
UpdateUserPayload
Description
Autogenerated return type of UpdateUser
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - User
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": User
}
UpdateUserSettingsInput
Description
Autogenerated input type of UpdateUserSettings
Fields
| Input Field | Description |
|---|---|
_24HourTime - Boolean
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
personalizedData - [UserPersonalizedDataItemInput!]
|
Example
{
"_24HourTime": false,
"clientMutationId": "xyz789",
"personalizedData": [UserPersonalizedDataItemInput]
}
UpdateUserSettingsPayload
Description
Autogenerated return type of UpdateUserSettings
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Whoami
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Whoami
}
UpdateWorkspaceGroupsInput
Description
Autogenerated input type of UpdateWorkspaceGroups
Example
{
"clientMutationId": "abc123",
"groupIds": [4]
}
UpdateWorkspaceGroupsPayload
Description
Autogenerated return type of UpdateWorkspaceGroups
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [Group!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [Group]
}
UpdateWorkspaceInput
Description
Autogenerated input type of UpdateWorkspace
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
industry - WorkspaceIndustryEnum
|
|
logoKey - String
|
|
metadata - JSON
|
|
name - String
|
|
size - WorkspaceSizeEnum
|
|
timezone - String
|
|
workspaceId - ID!
|
Example
{
"clientMutationId": "xyz789",
"industry": "CLEANING",
"logoKey": "xyz789",
"metadata": {},
"name": "xyz789",
"size": "LESS_THAN_TEN",
"timezone": "xyz789",
"workspaceId": "4"
}
UpdateWorkspacePayload
Description
Autogenerated return type of UpdateWorkspace
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Workspace
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Workspace
}
UpdateWorkspaceSettingsInput
Description
Autogenerated input type of UpdateWorkspaceSettings
Fields
| Input Field | Description |
|---|---|
_24HourTime - Boolean
|
|
autoApproveTimeoffRequest - Boolean
|
|
autoClockOutAfterShiftEndTimeDuration - Minute
|
|
autoDeductUnpaidBreaks - Boolean
|
|
birthdayReminder - Boolean
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
disabledFeatures - [WorkspaceFeatureEnum!]
|
|
employeeAvailability - EmployeeAvailabilityEnum
|
|
facialClockIn - Boolean
|
|
kioskAttendance - Boolean
|
|
locationClockIn - Boolean
|
|
locationClockInPreventIfExceeded - Boolean
|
|
locationClockInRadius - Int
|
|
missedClockEventsEmployeeNotiDelay - Minute
|
|
missedClockEventsManagerNotiDelay - Minute
|
|
mobileAttendance - Boolean
|
|
preventFinishShiftsWhenHavingUncompletedTasks - Boolean
|
|
privateScheduling - Boolean
|
|
publicApprovedTimeoffRequest - Boolean
|
|
shiftClockInEarlyThreshold - Minute
|
|
shiftClockOutEarlyThreshold - Minute
|
|
shiftEndTimeOffset - Minute
|
|
shiftStartTimeOffset - Minute
|
|
timesheetAutoRound - Boolean
|
|
timesheetRoundBreakIncrement - Minute
|
|
timesheetRoundBreakToScheduledBreakIfShorter - Boolean
|
|
timesheetRoundBreakType - TimesheetRoundBreakTypeEnum
|
|
timesheetRoundEndTimeIncrement - Minute
|
|
timesheetRoundEndTimeToScheduledTimeIfAfter - Boolean
|
|
timesheetRoundEndTimeToScheduledTimeIfEarlier - Boolean
|
|
timesheetRoundEndTimeType - TimesheetRoundTimeTypeEnum
|
|
timesheetRoundStartTimeIncrement - Minute
|
|
timesheetRoundStartTimeToScheduledTimeIfEarlier - Boolean
|
|
timesheetRoundStartTimeType - TimesheetRoundTimeTypeEnum
|
|
typicalWorkDuration - Minute
|
|
unscheduledShifts - Boolean
|
|
weekStartsOn - Int
|
|
wifiClockIn - Boolean
|
|
workAniversaryReminder - Boolean
|
|
workspaceId - ID!
|
Example
{
"_24HourTime": true,
"autoApproveTimeoffRequest": true,
"autoClockOutAfterShiftEndTimeDuration": Minute,
"autoDeductUnpaidBreaks": true,
"birthdayReminder": false,
"clientMutationId": "xyz789",
"disabledFeatures": ["ADVANCED_SCHEDULING"],
"employeeAvailability": "APPROVAL_REQUIRED",
"facialClockIn": true,
"kioskAttendance": true,
"locationClockIn": false,
"locationClockInPreventIfExceeded": false,
"locationClockInRadius": 123,
"missedClockEventsEmployeeNotiDelay": Minute,
"missedClockEventsManagerNotiDelay": Minute,
"mobileAttendance": true,
"preventFinishShiftsWhenHavingUncompletedTasks": false,
"privateScheduling": false,
"publicApprovedTimeoffRequest": true,
"shiftClockInEarlyThreshold": Minute,
"shiftClockOutEarlyThreshold": Minute,
"shiftEndTimeOffset": Minute,
"shiftStartTimeOffset": Minute,
"timesheetAutoRound": false,
"timesheetRoundBreakIncrement": Minute,
"timesheetRoundBreakToScheduledBreakIfShorter": false,
"timesheetRoundBreakType": "CLOSER",
"timesheetRoundEndTimeIncrement": Minute,
"timesheetRoundEndTimeToScheduledTimeIfAfter": false,
"timesheetRoundEndTimeToScheduledTimeIfEarlier": false,
"timesheetRoundEndTimeType": "CLOSER",
"timesheetRoundStartTimeIncrement": Minute,
"timesheetRoundStartTimeToScheduledTimeIfEarlier": true,
"timesheetRoundStartTimeType": "CLOSER",
"typicalWorkDuration": Minute,
"unscheduledShifts": false,
"weekStartsOn": 123,
"wifiClockIn": false,
"workAniversaryReminder": true,
"workspaceId": 4
}
UpdateWorkspaceSettingsPayload
Description
Autogenerated return type of UpdateWorkspaceSettings
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Workspace
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": Workspace
}
UploadSchedulePhotoInput
Description
Autogenerated input type of UploadSchedulePhoto
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
endTime - ISO8601DateTime!
|
|
photos - [String!]!
|
|
scheduleId - ID
|
|
startTime - ISO8601DateTime!
|
Example
{
"clientMutationId": "abc123",
"endTime": ISO8601DateTime,
"photos": ["abc123"],
"scheduleId": 4,
"startTime": ISO8601DateTime
}
UploadSchedulePhotoPayload
Description
Autogenerated return type of UploadSchedulePhoto
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - [SchedulePhoto!]
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": [SchedulePhoto]
}
UploaderEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AVATAR"
User
Fields
| Field Name | Description |
|---|---|
address - String
|
|
avatarUrl - String
|
|
birthday - ISO8601DateTime
|
|
dataState - UserDataStateEnum
|
|
email - String
|
|
firstName - String!
|
|
groups - [Group!]
|
|
id - ID!
|
|
kioskPinCode - String
|
|
lastName - String
|
|
membershipSettings - MembershipSetting
|
|
name - String!
|
|
phoneNumber - String
|
|
roles - [RoleCodeEnum!]
|
|
sampleUser - Boolean!
|
|
schedules - [Schedule!]
|
|
state - UserStateEnum!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"address": "xyz789",
"avatarUrl": "abc123",
"birthday": ISO8601DateTime,
"dataState": "COMPLETE",
"email": "xyz789",
"firstName": "abc123",
"groups": [Group],
"id": 4,
"kioskPinCode": "xyz789",
"lastName": "abc123",
"membershipSettings": MembershipSetting,
"name": "abc123",
"phoneNumber": "xyz789",
"roles": ["CONTRACTOR"],
"sampleUser": true,
"schedules": [Schedule],
"state": "ACTIVE",
"updatedAt": ISO8601DateTime
}
UserConnection
Description
The connection type for User.
Fields
| Field Name | Description |
|---|---|
edges - [UserEdge]
|
A list of edges. |
nodes - [User]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [UserEdge],
"nodes": [User],
"pageInfo": PageInfo,
"totalCount": 987
}
UserDataStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPLETE"
UserEdge
UserFilter
Fields
| Input Field | Description |
|---|---|
_or - [UserFilter!]
|
|
groupIds - [ID!]
|
|
keyword - String
|
|
offOnDate - ISO8601DateTime
|
|
scheduleIds - [ID!]
|
|
userDataStates - [UserDataStateEnum!]
|
|
userStates - [UserStateEnum!]
|
|
workingOnDate - ISO8601DateTime
|
Example
{
"_or": [UserFilter],
"groupIds": ["4"],
"keyword": "xyz789",
"offOnDate": ISO8601DateTime,
"scheduleIds": ["4"],
"userDataStates": ["COMPLETE"],
"userStates": ["ACTIVE"],
"workingOnDate": ISO8601DateTime
}
UserInput
Fields
| Input Field | Description |
|---|---|
address - String
|
|
avatarKey - String
|
|
birthday - ISO8601DateTime
|
|
email - String!
|
|
firstName - String
|
|
groupIds - [ID!]
|
|
lastName - String
|
|
phoneNumber - String
|
|
roles - [RoleCodeEnum!]
|
|
scheduleIds - [ID!]
|
|
settings - UserSettingsInput
|
|
timezone - String
|
Example
{
"address": "abc123",
"avatarKey": "abc123",
"birthday": ISO8601DateTime,
"email": "abc123",
"firstName": "abc123",
"groupIds": [4],
"lastName": "xyz789",
"phoneNumber": "abc123",
"roles": ["CONTRACTOR"],
"scheduleIds": ["4"],
"settings": UserSettingsInput,
"timezone": "xyz789"
}
UserOrder
Fields
| Input Field | Description |
|---|---|
column - UserOrderColumnsEnum!
|
|
direction - OrderOrientEnum!
|
Example
{"column": "NAME", "direction": "ASC"}
UserOrderColumnsEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
UserPersonalizedDataItem
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
key - String!
|
|
updatedAt - ISO8601DateTime!
|
|
value - String!
|
Example
{
"createdAt": ISO8601DateTime,
"key": "abc123",
"updatedAt": ISO8601DateTime,
"value": "abc123"
}
UserPersonalizedDataItemInput
UserSetting
Fields
| Field Name | Description |
|---|---|
_24HourTime - Boolean!
|
|
personalizedData - [UserPersonalizedDataItem!]!
|
Example
{
"_24HourTime": true,
"personalizedData": [UserPersonalizedDataItem]
}
UserSettingsInput
UserStateEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
VerifyJoinCodeInput
VerifyJoinCodePayload
Description
Autogenerated return type of VerifyJoinCode
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - VerifyJoinCodeResult
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": VerifyJoinCodeResult
}
VerifyJoinCodeResult
VerifyKioskOtpInput
VerifyKioskOtpPayload
Description
Autogenerated return type of VerifyKioskOtp
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - KioskJwtPayload
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": KioskJwtPayload
}
VerifyOtpInput
VerifyOtpPayload
Description
Autogenerated return type of VerifyOtp
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - JwtPayload
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": JwtPayload
}
ViewMessageBoardPostInput
ViewMessageBoardPostPayload
Description
Autogenerated return type of ViewMessageBoardPost
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - MessageBoardPost
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": MessageBoardPost
}
VisibilityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRIVATE"
Whoami
Fields
| Field Name | Description |
|---|---|
address - String
|
|
avatarUrl - String
|
|
birthday - ISO8601DateTime
|
|
createdAt - ISO8601DateTime!
|
|
email - String
|
|
firstName - String
|
|
id - ID!
|
|
kioskPinCode - String
|
|
language - String!
|
|
lastName - String
|
|
membershipSettings - MembershipSetting
|
|
name - String!
|
|
phoneNumber - String
|
|
roles - [Role!]!
|
|
settings - UserSetting
|
|
timezone - String!
|
Example
{
"address": "xyz789",
"avatarUrl": "xyz789",
"birthday": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"email": "abc123",
"firstName": "abc123",
"id": "4",
"kioskPinCode": "xyz789",
"language": "xyz789",
"lastName": "abc123",
"membershipSettings": MembershipSetting,
"name": "xyz789",
"phoneNumber": "abc123",
"roles": [Role],
"settings": UserSetting,
"timezone": "abc123"
}
WithdrawLeaveInput
WithdrawLeavePayload
Description
Autogenerated return type of WithdrawLeave
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - LeaveRequest
|
Example
{
"clientMutationId": "abc123",
"errors": [MutationError],
"result": LeaveRequest
}
WithdrawTimesheetInput
WithdrawTimesheetPayload
Description
Autogenerated return type of WithdrawTimesheet
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
errors - [MutationError!]!
|
|
result - Timesheet
|
Example
{
"clientMutationId": "xyz789",
"errors": [MutationError],
"result": Timesheet
}
Workspace
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
industry - WorkspaceIndustryEnum
|
|
logoUrl - String
|
|
metadata - JSON
|
|
meteredUsages - [MeteredUsage!]!
|
|
name - String!
|
|
settings - WorkspaceSetting!
|
|
size - WorkspaceSizeEnum
|
|
timezone - String!
|
Example
{
"createdAt": ISO8601DateTime,
"id": 4,
"industry": "CLEANING",
"logoUrl": "abc123",
"metadata": {},
"meteredUsages": [MeteredUsage],
"name": "abc123",
"settings": WorkspaceSetting,
"size": "LESS_THAN_TEN",
"timezone": "abc123"
}
WorkspaceConnection
Description
The connection type for Workspace.
Fields
| Field Name | Description |
|---|---|
edges - [WorkspaceEdge]
|
A list of edges. |
nodes - [Workspace]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
totalCount - Int!
|
Example
{
"edges": [WorkspaceEdge],
"nodes": [Workspace],
"pageInfo": PageInfo,
"totalCount": 123
}
WorkspaceEdge
WorkspaceFeatureEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADVANCED_SCHEDULING"
WorkspaceGetStartedStep
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - WorkspaceGetStartedStepNameEnum!
|
|
order - Int!
|
|
state - GetStartedStepStateEnum!
|
Example
{"id": 4, "name": "ADD_YOUR_TEAM", "order": 987, "state": "FINISHED"}
WorkspaceGetStartedStepNameEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADD_YOUR_TEAM"
WorkspaceIndustryEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLEANING"
WorkspaceInfoInput
Fields
| Input Field | Description |
|---|---|
industry - WorkspaceIndustryEnum
|
|
metadata - JSON
|
|
name - String!
|
|
redemptionCode - String
|
|
size - WorkspaceSizeEnum
|
|
timezone - String!
|
Example
{
"industry": "CLEANING",
"metadata": {},
"name": "abc123",
"redemptionCode": "xyz789",
"size": "LESS_THAN_TEN",
"timezone": "abc123"
}
WorkspaceSetting
Fields
| Field Name | Description |
|---|---|
_24HourTime - Boolean!
|
|
autoApproveTimeoffRequest - Boolean!
|
|
autoClockOutAfterShiftEndTimeDuration - Minute!
|
|
autoDeductUnpaidBreaks - Boolean!
|
|
birthdayReminder - Boolean!
|
|
disabledFeatures - [WorkspaceFeatureEnum!]!
|
|
employeeAvailability - EmployeeAvailabilityEnum!
|
|
facialClockIn - Boolean!
|
|
hadDemo - Boolean!
|
|
hasSampleData - Boolean!
|
|
kioskAttendance - Boolean!
|
|
locationClockIn - Boolean!
|
|
locationClockInPreventIfExceeded - Boolean!
|
|
locationClockInRadius - Int!
|
|
missedClockEventsEmployeeNotiDelay - Minute!
|
|
missedClockEventsManagerNotiDelay - Minute!
|
|
mobileAttendance - Boolean!
|
|
preventFinishShiftsWhenHavingUncompletedTasks - Boolean!
|
|
privateScheduling - Boolean!
|
|
publicApprovedTimeoffRequest - Boolean!
|
|
shiftClockInEarlyThreshold - Minute!
|
|
shiftClockOutEarlyThreshold - Minute!
|
|
shiftEndTimeOffset - Minute!
|
|
shiftStartTimeOffset - Minute!
|
|
timesheetAutoRound - Boolean!
|
|
timesheetRoundBreakIncrement - Minute!
|
|
timesheetRoundBreakToScheduledBreakIfShorter - Boolean!
|
|
timesheetRoundBreakType - TimesheetRoundBreakTypeEnum!
|
|
timesheetRoundEndTimeIncrement - Minute!
|
|
timesheetRoundEndTimeToScheduledTimeIfAfter - Boolean!
|
|
timesheetRoundEndTimeToScheduledTimeIfEarlier - Boolean!
|
|
timesheetRoundEndTimeType - TimesheetRoundTimeTypeEnum!
|
|
timesheetRoundStartTimeIncrement - Minute!
|
|
timesheetRoundStartTimeToScheduledTimeIfEarlier - Boolean!
|
|
timesheetRoundStartTimeType - TimesheetRoundTimeTypeEnum!
|
|
typicalWorkDuration - Minute!
|
|
unscheduledShifts - Boolean!
|
|
weekStartsOn - Int!
|
|
wifiClockIn - Boolean!
|
|
workAniversaryReminder - Boolean!
|
Example
{
"_24HourTime": true,
"autoApproveTimeoffRequest": true,
"autoClockOutAfterShiftEndTimeDuration": Minute,
"autoDeductUnpaidBreaks": false,
"birthdayReminder": false,
"disabledFeatures": ["ADVANCED_SCHEDULING"],
"employeeAvailability": "APPROVAL_REQUIRED",
"facialClockIn": false,
"hadDemo": false,
"hasSampleData": false,
"kioskAttendance": true,
"locationClockIn": true,
"locationClockInPreventIfExceeded": false,
"locationClockInRadius": 123,
"missedClockEventsEmployeeNotiDelay": Minute,
"missedClockEventsManagerNotiDelay": Minute,
"mobileAttendance": true,
"preventFinishShiftsWhenHavingUncompletedTasks": true,
"privateScheduling": false,
"publicApprovedTimeoffRequest": false,
"shiftClockInEarlyThreshold": Minute,
"shiftClockOutEarlyThreshold": Minute,
"shiftEndTimeOffset": Minute,
"shiftStartTimeOffset": Minute,
"timesheetAutoRound": true,
"timesheetRoundBreakIncrement": Minute,
"timesheetRoundBreakToScheduledBreakIfShorter": true,
"timesheetRoundBreakType": "CLOSER",
"timesheetRoundEndTimeIncrement": Minute,
"timesheetRoundEndTimeToScheduledTimeIfAfter": false,
"timesheetRoundEndTimeToScheduledTimeIfEarlier": false,
"timesheetRoundEndTimeType": "CLOSER",
"timesheetRoundStartTimeIncrement": Minute,
"timesheetRoundStartTimeToScheduledTimeIfEarlier": true,
"timesheetRoundStartTimeType": "CLOSER",
"typicalWorkDuration": Minute,
"unscheduledShifts": false,
"weekStartsOn": 987,
"wifiClockIn": false,
"workAniversaryReminder": false
}
WorkspaceSizeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LESS_THAN_TEN"