Query Operators by Email

Description

This API will return the Hi Marley Operator associated with the email passed in the body of the request.

Service Name	Query Operators by Email
Service Type	REST
Method	POST
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/operators/query
Production URL	https://integration.himarley.io/api/v2/operators/query
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Header Breakdown
• API Response
  • Response Payload Example

  • Response Fields Breakdown

API Request

Flow

1. Send API request with the operator email in the body.
2. Hi Marley receives the request and validates the operator exists; this is validated by checking if an existing email is present for any operator in that org.
3. Hi Marley responds with the operator's object data.

Request Example

https://integration.uat.marley.ai/api/v2/operators/query

{
 "email": "[e-mail]"
}

 

Request Body Breakdown

Property	Description	Type	Required	Example	Validation
email	The email of the operator.	string	true	"[e-mail]"	The email exists for an operator within the org.

 

API Response 

Response Payload Example

{
    "users": [
      {
        "id": "0a996f68-37ef-42fd-b54c-7283beb2c881",
        "firstName": "James",
        "lastName": "Zimmerman",
        "email": "[e-mail]",
        "mobile": "8449627539",
        "roles": [
          "ADMIN"
        ]
      }
  ],
  "pagination": {
      "count": 1,
      "currentPage": "/v2/operators/query?pageSize=10&page=1",
      "totalPages": 1,
      "pageSize": 10,
      "nextPage": null,
      "prevPage": null
  }
}

 

Response Fields Breakdown

Proptery	Element	Description	Type	Required	Example
id		The identifier generated and assigned to the operator.	string	true	"id": "14db69c0-af9c-41a4-a9e9-403d4b6898ae1"
firstName		The operators given name.	string	true	"first": "James"
lastName		The operators surname.	string	true	"last": "Zimmerman"
email		The operators email address.	string	true	"email": "[e-mail]"
mobile		The operators mobile number.	int	false	"mobile": "5552325555"
title		The operators title.	string	false	"title": "operator"
role		The operators role.	enum	true	"role": "operator"
pagination	count	Number of operators returned	number	true	"count": 3
	currentPage	Indicates path of the current page returned	string	true	"currentPage": "/v2/operators/query?pageSize=10&page=1"
	totalPages	Indicates number of pages returned	number	true	"totalPages": 1
	pageSize	Max amount of operators that can be displayed on this response (always 10)	number	true	"pageSize": 10
	nextPage	Indicates if more operators can be returned on the next page	string	true	"nextPage": null
	prevPage	Indicates if more operators can be returned on the previous page	string	true	"prevPage"