Skip to main content

Query All Operators

James Zimmerman
  • Updated

Description

* Targeting 2.84 Release on 4/15/26 - Now available in UAT.

The Query All Operators API allows carriers to programmatically retrieve all operators in their organization. This enables carriers to perform a bulk retrieval of users, supporting automated compliance and auditing workflows.

Service Name Query All Operators
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.

 

API Request

Note: This endpoint utilizes the existing Query Operators (api/v2/operators/query) endpoint. Sending a request to this endpoint with an empty body (no email field) will return all operators by default.

Flow

  1. Send POST request with empty payload (no email field).
  2. Hi Marley authenticates the request.
  3. Hi Marley responds with all operators in the organization, paginated.

Request Example

POST https://integration.uat.marley.ai/api/v2/operators/query
Body: {}

Note: The Query All Operators endpoint expects a payload to be included - To return all operators, ensure an empty object ( {} ) is included as a payload.

Response Example

{
    "users": [
        {
            "id": "0a996f68-37ef-42fd-b54c-7283beb2c881",
            "firstName": "James",
            "lastName": "Zimmerman",
            "email": "james.zimmerman@himarley.com",
            "mobile": "8449627539",
            "roles": [
                "ADMIN"
            ]
        },
        {
            "id": "b12dc4a1-8e3f-4a91-a6c2-91d4e7f50123",
            "firstName": "Jane",
            "lastName": "Smith",
            "email": "jane.smith@himarley.com",
            "roles": [
                "OPERATOR"
            ]
        }
    ],
    "pagination": {
        "count": 2,
        "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": "james.zimmerman@himarley.com"

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"

 

 

Related articles