Skip to main content
POST
/
api
/
integrations
/
accessControl
/
testBoulevardConnection
Test Boulevard API connection
curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/accessControl/testBoulevardConnection \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "apiToken": "<string>",
  "boulevardBusinessId": "<string>"
}
'
{
  "error": true,
  "errorMessage": "<string>",
  "errorMsg": "<string>",
  "locations": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "success": true,
  "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

Request object for testing Boulevard API connection.

apiToken
string | null

Boulevard API token to test

boulevardBusinessId
string | null

Boulevard business ID to test

Response

200 - application/json

OK

Response object for testing Boulevard API connection.

error
boolean | null
errorMessage
string | null

Error message if connection test failed

errorMsg
string | null
locations
object[] | null

List of Boulevard locations available for the business

success
boolean | null

Whether the connection test was successful

warningMsg
string | null