Skip to main content
POST
/
api
/
report
/
getEnvoyEmployees
Get Envoy employees
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getEnvoyEmployees \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationIds": [
    "<string>"
  ]
}
'
{
  "employees": [
    {
      "email": "<string>",
      "id": "<string>",
      "locationIds": [
        "<string>"
      ],
      "locations": [
        "<string>"
      ],
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json
locationIds
(string | null)[] | null

Response

200 - application/json

OK

employees
object[] | null
error
boolean | null
errorMsg
string | null
warningMsg
string | null