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

    Querying and Sorting

    All of the eazy2biz cloud APIs have querying and sorting implemented to effectively fetch the right data consistently.

    Querying#

    To query a particular entity, use the filter endpoint. To pass what is to be queried, you need to pass an EntitySearch object in the payload body.
    In this typescript object, one can pass the FieldSearch object, which would specify what is to be queried, effectively forming a query language in the EntitySearch object.
    We support almost all types of SearchTypes:
    - REGEX
    - VALUE_EQUAL
    - VALUE_NOT_EQUAL_TO
    - VALUE_GREATER_THAN
    - VALUE_GREATER_THAN_EQUAL_TO
    - VALUE_LESS_THAN
    - VALUE_LESS_THAN_EQUAL_TO
    - VALUE_IN_ARRAY
    - VALUE_NOT_IN_ARRAY
    - FIELD_EXISTS

    Sorting#

    To sort the data, the sortQuery is specified in the EntitySearch object. You can pass multiple sort queries, and it will honour all of them.
    Modified at 2024-07-09 18:36:07
    Previous
    Pagination
    Next
    Rate Limit
    Built with