team tools · Foyer Connect

`team.byId`

read-only

Team: by id. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`userId`	string	yes

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`email`	string · nullable	yes
`phone`	string · nullable	yes
`role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`locale`	string	yes
`name`	string · nullable	yes
`image`	string · nullable	yes
`icalToken`	string · nullable	yes
`paymentKind`	enum	yes	One of: per_task, hourly, monthly_fixed, none
`paymentAmountCents`	integer · nullable	yes
`paymentCurrency`	string	yes
`taskKinds`	array of enum	yes
`notificationChannelPref`	enum	yes	One of: email, sms, whatsapp, none
`notificationEventPrefs`	object	yes
`inviteChannelUsed`	enum · nullable	yes	One of: email, sms, whatsapp
`inviteSentAt`	string · nullable	yes
`deletedAt`	string · nullable	yes
`lastDailySummaryAt`	string · nullable	yes
`createdAt`	string	yes

`team.create`

writes

Team: create. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`name`	string	yes
`email`	string · nullable	no
`phone`	string · nullable	no
`locale`	string	no	Default: "de"
`role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`taskKinds`	array of enum	no	Default: []
`paymentKind`	enum	no	One of: per_task, hourly, monthly_fixed, none — Default: "none"
`paymentAmountCents`	integer · nullable	no
`paymentCurrency`	string	no	Default: "EUR"
`notificationChannelPref`	enum	no	One of: email, sms, whatsapp, none — Default: "email"
`preferredRoomIds`	array of string	no	Default: []

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`email`	string · nullable	yes
`phone`	string · nullable	yes
`role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`locale`	string	yes
`name`	string · nullable	yes
`image`	string · nullable	yes
`icalToken`	string · nullable	yes
`paymentKind`	enum	yes	One of: per_task, hourly, monthly_fixed, none
`paymentAmountCents`	integer · nullable	yes
`paymentCurrency`	string	yes
`taskKinds`	array of enum	yes
`notificationChannelPref`	enum	yes	One of: email, sms, whatsapp, none
`notificationEventPrefs`	object	yes
`inviteChannelUsed`	enum · nullable	yes	One of: email, sms, whatsapp
`inviteSentAt`	string · nullable	yes
`deletedAt`	string · nullable	yes
`lastDailySummaryAt`	string · nullable	yes
`createdAt`	string	yes

`team.list`

read-only

Team: list. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`role`	enum	no	One of: owner, staff, reception, housekeeping, maintenance
`search`	string	no
`includeDeleted`	boolean	no	Default: false
`page`	integer	no	Default: 1

Output fields

Field	Type	Required	Notes
`rows`	array of object	yes
`rows.id`	string	yes
`rows.tenantId`	string	yes
`rows.email`	string · nullable	yes
`rows.phone`	string · nullable	yes
`rows.role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`rows.locale`	string	yes
`rows.name`	string · nullable	yes
`rows.image`	string · nullable	yes
`rows.icalToken`	string · nullable	yes
`rows.paymentKind`	enum	yes	One of: per_task, hourly, monthly_fixed, none
`rows.paymentAmountCents`	integer · nullable	yes
`rows.paymentCurrency`	string	yes
`rows.taskKinds`	array of enum	yes
`rows.notificationChannelPref`	enum	yes	One of: email, sms, whatsapp, none
`rows.notificationEventPrefs`	object	yes
`rows.inviteChannelUsed`	enum · nullable	yes	One of: email, sms, whatsapp
`rows.inviteSentAt`	string · nullable	yes
`rows.deletedAt`	string · nullable	yes
`rows.lastDailySummaryAt`	string · nullable	yes
`rows.createdAt`	string	yes
`page`	integer	yes
`hasMore`	boolean	yes

`team.listForRecipients`

read-only

Team: list for recipients. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Field	Type	Required	Notes
`rows`	array of object	yes
`rows.id`	string	yes
`rows.name`	string · nullable	yes
`rows.email`	string · nullable	yes
`rows.phone`	string · nullable	yes
`rows.role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance

`team.listRooms`

read-only

Team: list rooms. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

Field	Type	Required	Notes
`id`	string	yes
`name`	string	yes

`team.me`

read-only

Team: me. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`email`	string · nullable	yes
`phone`	string · nullable	yes
`role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`locale`	string	yes
`name`	string · nullable	yes
`image`	string · nullable	yes
`icalToken`	string · nullable	yes
`paymentKind`	enum	yes	One of: per_task, hourly, monthly_fixed, none
`paymentAmountCents`	integer · nullable	yes
`paymentCurrency`	string	yes
`taskKinds`	array of enum	yes
`notificationChannelPref`	enum	yes	One of: email, sms, whatsapp, none
`notificationEventPrefs`	object	yes
`inviteChannelUsed`	enum · nullable	yes	One of: email, sms, whatsapp
`inviteSentAt`	string · nullable	yes
`deletedAt`	string · nullable	yes
`lastDailySummaryAt`	string · nullable	yes
`createdAt`	string	yes

`team.preferredRooms.list`

read-only

Team: preferred rooms list. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`userId`	string	yes

Output fields

Returns array of object. Fields of each element:

Field	Type	Required
`id`	string	yes
`tenantId`	string	yes
`roomId`	string	yes
`userId`	string	yes
`priority`	integer	yes
`createdAt`	string	yes

`team.preferredRooms.set`

writes

Team: preferred rooms set. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`userId`	string	yes
`roomIds`	array of string	yes

Output fields

Field	Type	Required	Notes
`ok`	boolean	yes

`team.sendInvite`

writes

Resend a team member's invite email.

Input parameters

Field	Type	Required	Notes
`userId`	string	yes
`channel`	enum	yes	One of: email, sms, whatsapp

Output fields

One of 2 shapes, depending on the outcome:

Shape 1

Field	Type	Required	Notes
`ok`	literal	yes	One of: true
`inviteUrl`	string	yes

Shape 2

Field	Type	Required	Notes
`ok`	literal	yes	One of: false
`channelError`	literal	yes	One of: whatsapp_not_configured
`inviteUrl`	string	yes

`team.softDelete`

writesconfirm

Deactivate (soft-delete) a team member, revoking their access.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`email`	string · nullable	yes
`phone`	string · nullable	yes
`role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`locale`	string	yes
`name`	string · nullable	yes
`image`	string · nullable	yes
`icalToken`	string · nullable	yes
`paymentKind`	enum	yes	One of: per_task, hourly, monthly_fixed, none
`paymentAmountCents`	integer · nullable	yes
`paymentCurrency`	string	yes
`taskKinds`	array of enum	yes
`notificationChannelPref`	enum	yes	One of: email, sms, whatsapp, none
`notificationEventPrefs`	object	yes
`inviteChannelUsed`	enum · nullable	yes	One of: email, sms, whatsapp
`inviteSentAt`	string · nullable	yes
`deletedAt`	string · nullable	yes
`lastDailySummaryAt`	string · nullable	yes
`createdAt`	string	yes

`team.update`

writes

Team: update. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`id`	string	yes
`name`	string	no
`email`	string · nullable	no
`phone`	string · nullable	no
`locale`	string	no	Default: "de"
`role`	enum	no	One of: owner, staff, reception, housekeeping, maintenance
`taskKinds`	array of enum	no	Default: []
`paymentKind`	enum	no	One of: per_task, hourly, monthly_fixed, none — Default: "none"
`paymentAmountCents`	integer · nullable	no
`paymentCurrency`	string	no	Default: "EUR"
`notificationChannelPref`	enum	no	One of: email, sms, whatsapp, none — Default: "email"
`preferredRoomIds`	array of string	no	Default: []
`image`	string	no
`notificationEventPrefs`	object	no

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`email`	string · nullable	yes
`phone`	string · nullable	yes
`role`	enum	yes	One of: owner, staff, reception, housekeeping, maintenance
`locale`	string	yes
`name`	string · nullable	yes
`image`	string · nullable	yes
`icalToken`	string · nullable	yes
`paymentKind`	enum	yes	One of: per_task, hourly, monthly_fixed, none
`paymentAmountCents`	integer · nullable	yes
`paymentCurrency`	string	yes
`taskKinds`	array of enum	yes
`notificationChannelPref`	enum	yes	One of: email, sms, whatsapp, none
`notificationEventPrefs`	object	yes
`inviteChannelUsed`	enum · nullable	yes	One of: email, sms, whatsapp
`inviteSentAt`	string · nullable	yes
`deletedAt`	string · nullable	yes
`lastDailySummaryAt`	string · nullable	yes
`createdAt`	string	yes