The monday.com users API lets you query a user's settings, contact information, permissions, and more.

The object types below provide additional data structures used across the users API’s CRUD operations. They extend the core types documented in the main users reference and are used to invite and activate users, update user details, and retrieve detailed user information.

ActivateUsersResult

An object containing the result of activating users via the API.

Field	Description	Supported Fields
activated_users `[User!]`	The users who were activated.
errors `[ActivateUsersError!]`	The errors that occurred during user activation. Use this field to check for calls that failed.	code `ActivateUsersErrorCode` message `String` user_id `ID`

ActivateUsersError

An object containing the error that occurred when an activate_users mutation fails.

Field	Description	Enum Values
code `ActivateUsersErrorCode`	The error code that occurred.	`CANNOT_UPDATE_SELF` `EXCEEDS_BATCH_LIMIT` `FAILED` `INVALID_INPUT` `USER_NOT_FOUND`
message `String`	The error message.
user_id `ID`	The unique identifier of the user that caused the error.

DeactivateUsersResult

An object containing the result of deactivating users via the API.

Field	Description
deactivated_users `[User]!`	Data from the users who were deactivated.
errors `[DeactivateUsersError]!`	The errors that occurred during deactivation. Use this field to check for calls that failed.

DeactivateUsersError

An object containing the error that occurred when an deactivate_users mutation fails.

Field	Description	Enum Values
code `DeactivateUsersErrorCode`	The error code that occurred.	`CANNOT_UPDATE_SELF` `EXCEEDS_BATCH_LIMIT` `FAILED` `INVALID_INPUT` `USER_NOT_FOUND`
message `String`	The error message.
user_id `ID`	The unique identifier of the user that caused the error.

InviteUsersResult

An object containing the result of inviting users via the API.

Field	Description
invited_users `[User!]`	Data from the users who were successfully invited.
errors `[InviteUsersError!]`	The errors that occurred during the invitation process. Use this field to check for calls that failed.

InviteUsersError

An object containing the error that occurred when an invite_users mutation fails.

Field	Description	Enum Values
code `InviteUsersErrorCode`	The error code that occurred.	`ERROR`
message `String`	The error message.
email `ID`	The email of the user that caused the error.

UpdateEmailDomainAttributesInput

An object containing the attributes to update.

Field	Description
new_domain `String!`	The updated email domain.
user_ids `[ID!]!`	The unique identifiers of the users to update. The maximum is 200.

UpdateUserAttributesResult

An object containing the result of updating users' attributes via the API.

Field	Description
errors `[UpdateUserAttributesError!]`	The errors that occurred while updating the users' attributes. Use this field to check for failed calls.
updated_users `[User!]`	Data from the users who were updated.

UpdateUserAttributesError

An object containing the error that occurred when an update_multiple_users mutation fails.

Field	Description	Enum Values
code `UpdateUserAttributesErrorCode`	The error code.	`INVALID_FIELD`
message `String`	The error message.
user_id `ID`	The unique identifier of the user that caused the error.

UpdateUsersEmailDomainResult

An object containing the result of updating a user's email domain via the API.

Field	Description
errors `[UpdateEmailDomainError!]`	The errors that occurred during the email domain update. Use this field to check for failed calls.
updated_users `[User!]`	Data from the users who were updated.

UpdateEmailDomainError

An object containing the error that occurred when an update_email_domain mutation fails.

Field	Description	Enum values
code `UpdateEmailDomainErrorCode`	The error code that occurred.	`CANNOT_UPDATE_SELF` `EXCEEDS_BATCH_LIMIT` `FAILED` `INVALID_INPUT` `UPDATE_EMAIL_DOMAIN_ERROR` `USER_NOT_FOUND`
message `String`	The error message.
user_id `ID`	The unique identifier of the user that caused the error.

UpdateUsersRoleResult

An object containing the result of updating a user's role via the API.

Field	Description
errors `[UpdateUsersRoleError!]`	The errors that occurred while updating the role. Use this field to check for calls that failed.
updated_users `[User]!`	Data from the users who were updated.

UpdateUsersRoleError

An object containing the error that occurred when an update_users_role mutation fails.

Field	Description	Enum Values
code `UpdateUsersRoleErrorCode`	The error code that occurred.	`CANNOT_UPDATE_SELF` `EXCEEDS_BATCH_LIMIT` `FAILED` `INVALID_INPUT` `USER_NOT_FOUND`
message `String`	The error message.
user_id `ID`	The unique identifier of the user that caused the error.

UserUpdateInput

An object containing the user IDs and attributes to update.

Field	Description
user_attribute_updates `UserAttributesInput!`	The attributes to update.
user_id `ID!`	The unique identifier of the user to update.

UserAttributesInput

An object containing the specific attributes to update.

Field	Description
birthday `String`	The user's updated birthday. Use YYYY-MM-DD format.
department `String`	The user's updated department.
email `String`	The user's updated email.
join_date `String`	The user's updated join date. Use YYYY-MM-DD format.
location `String`	The user's updated location.
mobile_phone `String`	The user's updated mobile phone number.
name `String`	The user's updated name.
phone `String`	The user's updated phone number.
title `String`	The user's updated title.