Skip to main content

user

Retrieve user information by ID or login email.

Returns user data for either system users or contacts based on the provided identifier. Access is restricted based on user permissions and relationships.

Possible errors:

  • USER_NOT_FOUND_ERROR: User with the specified ID or login does not exist
  • CONTACT_NOT_FOUND_ERROR: Contact with the specified login does not exist
  • USER_FETCH_ERROR: Failed to retrieve user information

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

user(
  id: Int
  login: String
): IBaseUser!

Arguments​

user.id ● Int scalar​

Unique identifier of the user to retrieve.

Must be a positive integer representing a valid user ID. Either this or login must be provided.

user.login ● String scalar​

Login email address of the user to retrieve.

Must be a valid email address associated with a user account. Either this or id must be provided.

Type​

IBaseUser interface​

Base interface for all user types in the system.

Defines common properties shared across users, contacts, and customers. This interface provides a unified structure for user-related data while allowing for type-specific implementations.