Get Operator by Email

Description

This API will return the Hi Marley Operator associated with the passed email. Note that email must be passed as a header in this request.

Service Name	Get Operator by Email
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/operators/
Production URL	https://integration.himarley.io/api/v2/operators/
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 as a header.
2. Hi Marley receives the request and validates the user 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

HEADER: email: "[e-mail]"

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

 

Request Header Breakdown

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

 

API Response 

Response Payload Example

{
"id": "14db69c0-af9c-41a4-a9e9-403d4b6898ae1",
"firstName": "James",
"lastName": "Zimmerman",
"email": "[e-mail]",
"mobile": "8449627539",
"title": "operator",
"roles": [
"OPERATOR"
]
}

 

Response Fields Breakdown

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"