eazy2biz-docs
    eazy2biz-docs
    • Getting Started
    • Overview
    • Authentication
    • Pagination
    • Querying and Sorting
    • Rate Limit
    • Scope
    • Identity
      • Identity Overview
      • Global User Token
        POST
      • Global User Offline Token
        POST
      • System Local User Offline Token (Company Impersonation)
        POST
      • API Client Access Offline Token
        POST
    • Activity
      • Create Activity
        POST
      • Filter Activities
        POST
      • Get All Activities for Entity
        POST
      • Get Activity for Entity by ID
        POST
      • Patch Activity Attributes for Entity by ID
        PATCH
      • Delete Activity for Entity by ID
        DELETE
    • Analytics
      • Chart
        • Get Charts in Report
        • Get Count of Charts in Report
        • Get Filtered Charts in Report
        • Get Count of Filtered Charts in Report
        • Simulate Chart in Report
        • Create Chart in Report
        • Get Chart in Report by ID
        • Get Chart Data in Report
        • Patch Chart Attributes in Report by ID
        • Delete Chart in Report by ID
      • Report
        • Get All Reports
        • Get Count of Reports
        • Create Report
        • Filter All Reports
        • Count of Filtered All Reports
        • Get Report by ID
        • Patch Report Attributes by ID
        • Delete Report by ID
    • Attachment
      • Create Attachment
        POST
      • Get all Attachments
        GET
      • Get count of all Attachments
        GET
      • Filter All Attachments
        POST
      • Count of Filtered Attachments
        POST
      • Get Attachment by ID
        GET
      • Download Attachment by ID
        GET
      • Patch Attachment Attributes by ID
        PATCH
      • Delete Attachment by ID
        DELETE
    • Customer Table
      • Create Customer Table
      • Get All Customer Tables
      • Get Count of All Customer Tables
      • Get Customer Table by ID
      • Patch Customer Table Attributes by ID
      • Delete Customer Table by ID
      • Add header to Customer Table
      • Get all Customer Table Headers
      • Get Customer Table Header by ID
      • Patch Customer Table Header Attributes by ID
      • Delete Customer Table Header by ID
      • Add Record to Customer Table
      • Get All Records in Customer Table
      • Get Count of All Records in Customer Table
      • Get Record in Customer Table by ID
      • Filter Records in Customer Table
      • Count of Filtered Records in Customer Table
      • Patch Record Attributes in Customer Table by ID
      • Delete Record in Customer Table by ID
    • Card
      • Override Stage Completion
      • Override Form Fields
      • Get All Cards In Workflow
      • Get Count of All Cards In Workflow
      • Filter All Cards In Workflow
      • Count of Filtered Cards In Workflow
      • Create Card In Workflow
      • Get Card In Workflow by ID
      • Patch Card Attributes In Workflow by ID
      • Delete Card In Workflow by ID
    • User Invite
      • Invite User To Company
      • Filter All Invites
      • Accept User Invite
      • Reject User Invite Copy
      • Get All User Invites
      • Get User Invite by ID
    • Global User Invite
      • Create Global User Invite
      • Get All Global User Invites
      • Count of all Global User Invites
      • Filter All Global User Invites
      • Count of Filtered Global User Invites
      • Reject Global User Invite
      • Get Global User Invite by ID
      • Delete Global User Invite by ID
    • Identities
      • Company
        • Get All Companies
        • Create Company
        • Get Companies For Global User
        • Get Company by ID
        • Patch Company Attributes
        • Delete company by ID
      • Company Settings
        • Create Company Setting
        • Get All Company Settings
        • Filter All Company Settings
        • Get Company Setting by Type
        • Get Company Setting by ID
        • Patch Company Setting by Type
        • Patch Company Setting by ID
        • Delete Company Setting by Type
        • Delete Company Setting by ID
      • Global User
        • Get All Global Users
        • Get Count Of All Global Users
        • Sign Up Global User
        • Resend Confirmation Passcode
        • Confirm Sign Up
        • Sign In
        • Refresh Token
        • Change password
        • Initiate Forward Password
        • Confirm Forgot Password
        • Get Global User By Email
        • Get Global User by Token
        • Add Mobile App Device Token
        • Remove Mobile App Device Token
        • Get Global User By ID
        • Patch Global User Attributes
        • Delete Global User By ID
      • Local User
        • Get All Local Users
        • Filter Local Users
        • Get Local Users by ID
        • Patch Local User Attributes by ID
        • Delete Local Users by ID
      • Security Group
        • Get all Security Groups
        • Create Security Group
        • Filter Security Groups
        • Add Local User in Security Group
        • Remove Local User in Security Group
        • Add User Group in Security Group
        • Remove User Group in Security Group
        • Check if Local User can perform Action on Feature
        • Check if Local User can perform Action on Feature Batch
        • Get All Actions Local User can perform on feature
        • Get all Security Groups by Feature & Action
        • Get Security Group by ID
        • Get Security Group by ID Copy
      • User Group
        • Get all User Groups
        • Create User Group
        • Filter User Groups
        • Add Local User to User Group
        • Remove Local User from User Group
        • Add User Group to User Group
        • Remove Local User from User Group Copy
        • Check Local User Membership in User Group
        • Get all User Groups a Local User is member of
        • Get all User Groups a Local User is directly member of
        • Get all User Groups a User Group is member of
        • Create User Group by ID
        • Patch User Group Attributes by ID
        • Delete User Group by ID
    • Template
      • WhatsApp
        • Get Status of WhatsApp Template
        • Send WhatsApp Message on Phone Number
      • Create Template
      • Create Template from System Template
      • Get All Templates in Category
      • Get Count of All Templates in Category
      • Filter All Templates in Category
      • Count of Filtered Templates in Category
      • Get Templates by ID in Category
      • Resolve Template by ID
      • Patch Templates Attributes by ID in Category
      • Delete Templates by ID in Category
    • Schedulable Trigger
      • Create Schedulable Trigger
      • Get all Schedulable Triggers
      • Get count of all Schedulable Triggers
      • Filter all Schedulable Triggers
      • Count of Filtered Schedulable Triggers
      • Get Schedulable Trigger by ID
      • Patch Schedulable Trigger Attribute by ID
      • Delete Schedulable Trigger by ID
    • User Todo
      • Create User Todo
      • Get All User Todos
      • Get Count of All User Todos
      • Filter All User Todos
      • Count of Filtered User Todos
      • Complete User Todo
      • Get User Todo by ID
      • Patch User Todo Attributes by ID
      • Delete User Todo by ID
    • Workflow
      • Stages
        • Get Workflow Stages by Workflow ID
        • Get All Workflow Stages by Workflow ID
        • Get Stage Form for Workflow Stage
      • Get All Workflows
      • Create Workflow
      • Filter All Workflows
      • Count of Filtered Workflows
      • Get Workflow by ID
      • Patch Workflow Attributes by ID
      • Delete Workflow by ID
    • Schemas
      • Enums
        • Action
          • Action Result
            • Email
              • EmailAttachmentType
          • ActionResultTypes
          • ActionStatus
        • Activity
          • ActivityType
          • EntityType
        • Aggregation
          • DateFieldAggregationType
        • Analytics
          • Chart Details
            • BarChartType
          • AggregatorType
          • ChartType
          • ReportEntityType
        • Card
          • CardActionStatus
          • CardStatus
        • Common
          • AccessTypes
          • ApprovalValues
          • AssigneeTypes
          • EntityDefinitionTypes
          • EntitySearchOperands
          • FieldValidationType
          • FileTypes
          • FileUploadStatus
          • MobileAppPlatform
          • SearchTypes
          • SortDirection
        • Condition
          • ExpressionType
          • LogicalOperator
          • Operators
        • Customer Table
          • CustomerTableHeaderTypes
          • CustomerTableHeaderValidationType
        • Global User Invite
          • GlobalUserInviteStatus
        • Identities
          • UserGroupType
          • LocalUserType
          • SecurityGroupFeatures
          • UserGroupMembershipType
          • CompanySettingType
        • Placeholder
          • CardStageSystemFields
          • CardSystemFields
          • FieldPlaceholderType
          • SystemFields
        • Schedulable Trigger
          • SchedulableTriggerCategory
        • Scheduled Task
          • ScheduledTaskFrequency
          • ScheduledTaskStatus
          • ScheduledTaskType
        • Template
          • WhatsApp
            • WhatsappTemplateTypes
          • TemplateCategory
          • TemplateStatus
          • TemplateTypes
        • User Invite
          • UserInviteStatus
        • User Todo
          • TodoStatus
          • TodoTypes
        • Workflow
          • ActionTypes
          • FieldTypes
          • StageTypes
      • POJOs
        • Action
          • Action Result Details
            • Email
              • PersistedEmailAttachment
              • TemplatedEmailAttachment
              • EmailAttachment
            • BaseActionResultDetails
            • ActivityCreateDetails
            • EmailDetails
            • MessageDetail
            • PushNotificationDetails
            • SaveTableRecordDetails
            • ScheduleTaskDetail
            • StageMovementDetail
            • TodoCreateDetails
            • TriggerStageCompletionDetail
            • TriggerWorkflowDetails
            • UnscheduleTaskDetail
            • WhatsappMessageDetails
          • ActionIdentifier
          • ActionExecutionResult
        • Aggregation
          • AggregationResult
        • Analytics
          • Chart Details
            • AreaChartDetails
            • BarChartDetails
            • LineChartDetails
            • PieChartDetails
            • TableChartColumn
            • TableChartDetails
          • ChartGrouping
          • ReportChartUIGridConfig
        • Card
          • Action
            • CardActionData
            • CardActionIdentifier
          • History
            • StageTraversalHistory
            • CardHistory
        • Common
          • Search
            • EntitySearch
            • FieldSearch
            • SortQuery
          • Details
          • FieldValidation
          • MetaData
        • Condition
          • Condition
          • ConditionExpression
        • Customer Table
          • CustomerTableHeaderValidation
          • CustomerTableHeader
        • Identities
          • Company Settings
            • BaseCompanySettings
            • GeneralCompanySettings
            • MessageCompanySettings
            • PaymentsCompanySettings
            • WhatsappCompanySettings
          • Global User
            • GlobalUserCompanyMembership
            • MobileAppDeviceToken
            • PhoneNumberContact
            • SignInTokens
          • Security Groups
            • SecurityGroupIdentifier
        • Placholder
          • FieldPlaceholder
        • Tag
          • Tag
        • Template
          • Template Additional Info
            • BaseTemplateAdditionalInfo
            • EmailTemplateAdditionalInfo
            • MessageTemplateAdditionalInfo
            • PDFTemplateAdditionalInfo
            • WhatsappMessageTemplateAdditionalInfo
            • WorkflowTemplateAdditionalInfo
          • Template Details
            • whatsapp
              • WhatsappURLCTA
              • WhatsappPhoneNumberCTA
              • WhatsappMessageTemplateDetails
            • BaseTemplateDetails
            • EmailTemplateDetails
            • MessageTemplateDetails
            • PDFTemplateDetails
            • WorkflowTemplateDetails
          • TemplateParameterCompleteDetails
          • TemplateReference
          • StringWithParametersCompleteDetails
          • TemplateParameter
        • Workflow
          • Action
            • ActionResult
            • Action
          • Field
            • FieldConfigurations
            • Field
          • Stage
            • StageActions
            • StageAssignee
            • Stage
            • StageFormEntity
          • WorkflowAccess
      • Request Payloads
        • Activity
          • ActivityCreateRequest
          • ActivityGroupIdentifierRequest
          • ActivityUpdateAttributes
          • FilterActivityRequest
          • UpdateActivityRequest
        • Analytics
          • Chart
            • ChartCreateRequest
            • ChartSimulateRequest
            • ChartUpdateAttributes
            • GetChartDataRequest
          • Report
            • ReportCreateRequest
            • ReportUpdateAttributes
        • Attachments
          • AttachmentUpdateAttributes
          • CreateAttachmentRequest
        • Card
          • CardCreateRequest
          • CardUpdateAttributes
          • CompleteStageRequest
          • OverrideFormFieldsRequest
        • Customer Table
          • Header
            • CustomerTableHeaderAddRequest
            • CustomerTableHeaderUpdateAttributes
          • Record
            • CustomerTableRecordAddRequest
            • CustomerTableRecordUpdateAttributes
          • CustomerTableCreateRequest
          • CustomerTableUpdateAttributes
        • Global User Invite
          • CreateGlobalUserInvite
        • Identities
          • Company
            • CompanyCreateRequest
            • CompanyUpdateAttributes
          • Company Settings
            • CompanySettingCreateRequest
            • CompanySettingIdentifier
            • CompanySettingUpdateAttributes
          • Global User
            • GlobalUserCreateRequest
            • ChangePasswordRequest
            • ForgotPasswordConfirmRequest
            • ConfirmSignUpRequest
            • ForgotPasswordInitiateRequest
            • GetGlobalUserByEmailRequest
            • GlobalUserUpdateAttributes
            • ResendConfirmationPasscodeRequest
            • SignInRequest
          • Local User
            • LocalUserUpdateAttributes
          • Security Groups
            • AddLocalUserToSecurityGroupRequest
            • AddUserGroupToSecurityGroupRequest
            • CheckLocalUserCanPerformActionOnFeatureBatchRequest
            • CheckLocalUserCanPerformActionOnFeatureRequest
            • GetAllActionsLocalUserCanPerformOnFeatureRequest
            • GetSecurityGroupByFeatureAndActionRequest
            • RemoveLocalUserFromSecurityGroupRequest
            • RemoveUserGroupFromSecurityGroupRequest
            • SecurityGroupCreateRequest
          • User Groups
            • AddLocalUserToUserGroupRequest
            • AddUserGroupToUserGroupRequest
            • CheckLocalUserInUserGroupRequest
            • RemoveLocalUserFromUserGroupRequest
            • RemoveUserGroupFromUserGroupRequest
            • UserGroupCreateRequest
            • UserGroupUpdateAttributes
        • Schedulable Trigger
          • SchedulableTriggerCreateRequest
          • SchedulableTriggerUpdateAttributes
        • Template
          • TemplateCreateFromSystemTemplateRequest
          • TemplateCreateRequest
          • TemplateUpdateAttributes
        • User Invite
          • InviteUserRequest
        • User Todo
          • CompleteTodoRequest
          • UserTodoCreateRequest
          • UserTodoUpdateAttributes
        • Workflow
          • GetStageFormRequest
          • GetStagesByStageIdsRequest
          • GetStagesByWorkflowIdRequest
          • WorkflowCreateRequest
          • WorkflowUpdateAttributes
      • Response Payloads
        • Activity
          • ActivityResponse
        • Analytics
          • Chart
            • ChartResponse
          • Report
            • ReportResponse
        • Attachment
          • AttachmentResponse
        • Card
          • CardResponse
        • Common
          • EntityResponse
        • Customer Table
          • CustomerTableHeaderContentResponse
          • CustomerTableRecordResponse
          • CustomerTableResponse
        • Global User Invite
          • GlobalUserInviteResponse
        • Identities
          • Company
            • CompanyResponse
          • Company Settings
            • CompanySettingsResponse
          • Global User
            • GlobalUserResponse
            • SignInResponse
          • Local User
            • LocalUserResponse
          • Security Group
            • CheckLocalUserCanPerformActionOnFeatureResponse
            • SecurityGroupResponse
          • User Group
            • UserGroupResponse
        • Schedulable Trigger
          • SchedulableTriggerResponse
        • Template
          • TemplateResponse
        • User Invite
          • UserInviteResponse
        • User Todo
          • UserTodoExecutableActionResponse
        • Workflow
          • Stage
          • WorkflowResponse
          • GetAllWorkflowsResponse

    Authentication


    To authenticate with the eazy2biz Cloud APIs, you'll need an access token. Generating this token requires providing specific details, namely the client_id, client_secret, api_key and scope to the Identity URL.
    Additionally, eazy2biz offers a multiple testing environment, allowing you to conduct integration testing for your applications.
    - QAL environment - Lower stability, but has the latest features.
    - E2E environment - Higher stability

    Authentication Details:#

    To generate the access token, you'll need the following details:
    1
    client_id
    Your client identifier for authentication
    2
    client_secret
    Your client secret for secure authentication.
    3
    api_key
    Your unique API key for accessing the system.
    4
    scope
    You will need to pass eazy2bizapi for this key.

    Identity URLs:#

    For generating the access token, you'll interact with the Identity URL to create the token. The endpoint for the token creation is - v1/identityManagement/apiKey/generateToken
    Depending on your environment, choose the appropriate base URL:
    - QAL environment - https://api.qal.eazy2biz.com/
    - E2E environment - https://api.e2e.eazy2biz.com/
    - PROD environment - https://api.eazy2biz.com/

    Environments:#

    eazy2biz provides a multiple Environment designed for integration testing purposes. This environment allows you to thoroughly test your applications' integration with the eazy2biz cloud APIs, ensuring seamless functionality before moving to production.
    - QAL environment - Lower stability, but has the latest features.
    - E2E environment - Higher stability
    - PROD environment - Highest stability
    Modified at 2024-07-09 18:36:11
    Previous
    Overview
    Next
    Pagination
    Built with