Skip to main content
POST
/
api
/
report
/
getEnvoyVisitors
Get Envoy visitors
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getEnvoyVisitors \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "endTimestampMs": 123,
  "includeSignedOutVisitors": true,
  "locationIds": [
    "<string>"
  ],
  "startTimestampMs": 123
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "invites": [
    {
      "expectedArrivalAt": "<string>",
      "expectedArrivalTimestampMs": 123,
      "host": {
        "email": "<string>",
        "id": "<string>",
        "locationIds": [
          "<string>"
        ],
        "locations": [
          "<string>"
        ],
        "name": "<string>",
        "type": "<string>"
      },
      "invitee": {
        "email": "<string>",
        "id": "<string>",
        "locationIds": [
          "<string>"
        ],
        "locations": [
          "<string>"
        ],
        "name": "<string>",
        "type": "<string>"
      },
      "locationId": "<string>"
    }
  ],
  "visitors": [
    {
      "agreementsStatus": "<string>",
      "email": "<string>",
      "fullName": "<string>",
      "host": {
        "email": "<string>",
        "id": "<string>",
        "locationIds": [
          "<string>"
        ],
        "locations": [
          "<string>"
        ],
        "name": "<string>",
        "type": "<string>"
      },
      "locationId": "<string>",
      "notes": "<string>",
      "signedInAt": "<string>",
      "signedInTimestampMs": 123,
      "signedOutAt": "<string>",
      "signedOutTimestampMs": 123
    }
  ],
  "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
endTimestampMs
integer<int64> | null
includeSignedOutVisitors
boolean | null
locationIds
(string | null)[] | null
startTimestampMs
integer<int64> | null

Response

200 - application/json

OK

error
boolean | null
errorMsg
string | null
invites
object[] | null
visitors
object[] | null
warningMsg
string | null