User

A User is a person opening a ticket on the Helpdesk.

Read All users

URL<base_uri> / <response_format> /users/?size=<size>&page=<page>
HTTP MethodGET
Response DataPaginated List of User
Additional Paramssize: number of items per page (minimum 10, maximum 50, default 10)
page: the number of the page required

Data Structure

                           

Read One User By ID

Retrieve details of a user using their ID.

URL<base_uri> / <response_format> /user/<id>/
HTTP MethodGET
Response Datauser

Data Structure

                           

Read One User By Email

Retrieve details of a user using their email address.

URL<base_uri> / <response_format> /user/<email>/
HTTP MethodGET
Response Datauser

Data Structure

                           

Bulk Create or Update Users

Retrieve details of a user using their email address.

URL<base_uri> / <response_format> /users/
HTTP MethodPOST
Request Data

One or more users along with their contact fields (if any required).

Note: Custom Fields needs to be translated to their respective IDs before posting to this end point. If the email id that you are passing already exists, the contact will be updated with the new details else will be created new.

Response DataList of email ids whose updates have been succeeded and failed.

Data Structure

                           


                           

Read All Contact Groups

 

URL<base_uri> / <response_format> /contact_groups/
HTTP MethodGET
Response DataList of contact groups

Data Structure

                           

Read One Contact Group by ID

 

URL<base_uri> / <response_format> /contact_group/ <id>
HTTP MethodGET
Response DataContact group

Data Structure

                           

New Contact Group

Create a contact group

URL<base_uri> / <response_format> /contact_groups/
HTTP MethodPOST
Request Data Create contact group
Response DataContact group

Data Structure

                           


                           

Edit Contact Group

 

URL<base_uri> / <response_format> /contact_group/ <id>
HTTP MethodPOST
Request DataEdit contact group
Response DataModified contact group

Data Structure