User object

Indicates whether the user has logged in for the first time.

Indicates the user most recent login timestamp.

passwordExpired

boolean

Indicates the user password expired and need to change or not.

status

string

Indicates the current status of the user account within an organization. Accepted values are:

`active` : The account is currently active and the user can perform actions based on their role.

                      `inactive` : The user has registered a new organization but has not completed email verification. 

                      `pending` : The user has been invited to this organization but has not yet accepted the invitation. 

                      `disabled` : The account has been deactivated by the organization and cannot be used. 

                      `reject` : The user has either accepted an invitation from another organization or created a new organization, causing all other pending invitations to be automatically rejected.

lockExpiry

string<date-time>

The Timestamp indicating when the user account is locked due to multiple incorrect login attempts. It specifies the date and time when the user can attempt to log in again.

teamId

object[]

Identifier the user is a part of what team.

roleId

string

Unique identifier for the user's role within the system or application

role

object[]

This is the root object, containing all the information about the role.

Show child attributes

role._id

string

Unique identifier for the role.

role.name

string

The name of the role.

role.isAdmin

boolean

A boolean value indicating whether the role is an admin role.

role.isDefault

boolean

Another boolean value indicating whether the role is a default role.

role.permissionList

array

An array containing IDs of permissions associated with this role.

role.permissionDetails

array

An array containing details about specific permissions associated with the role.

role.permissions

array

An array containing details about permissions granted to this role.

role.organizationId

string

Unique identifier for the organization to which this role belongs.

role.passwordPolicyId

string

ID of the password policy associated with this role, if any.

role.updatedTime

string

Timestamp indicating when this role was last updated.

role.createdTime

object

Timestamp indicating when this role was created.

hubId

object[]

Identifier for the hub that owns or manages the user.

organizationId

string

Identifier for the organization or company that owns or manages the user.

organization

object[]

Organization Entity Information: Encompasses the organization's name, email, and ID. This information is present in the task data upon task creation and processing.

Show child attributes

organization._id

string

Unique identifier for the organization.

organization.user

object

Information about the primary user associated with this organization.

organization.productId

string

The product ID that subscribed by the organization.

organization.productName

string

The product name that subscribed by the organization.

organization.status

string

Status of the organization.

organization.verifiedTime

string

Timestamp indicating when the organization was verified.

organization.curPeriodStartTime

string

Timestamp indicating the start time of the current subscription period.

organization.curPeriodEndTime

string

Timestamp indicating the end time of the current subscription period.

organization.eligible

boolean

A boolean value indicating whether the organization is eligible for certain benefits or services..

organization.configuration

object

Configuration settings associated with the organization.

organization.updatedTime

string

Timestamp indicating when the organization's information was last updated.

organization.createdTime

string

Timestamp indicating when the organization was created.

organization.customerId

object

Customer details for payment gateway.

organization.country

object

Information about the country associated with the organization.

updatedTime

string<date-time>

The Timestamp represents the last time the user data was updated. It includes date and time information.

createdTime

string<date-time>

The Timestamp represents the date and time when this user data was initially created.

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects