Skip to main content

Status

GET /api/v1/accessControl

Description

Get the current status for a AccessControl.

Response

HTTP Status Codes

CodeDescription
200Success, returns a Status
401Unauthorized, missing X-Red-Robin-API-Key header
403Forbidden, invalid X-Red-Robin-API-Key header
404Not found, invalid configuration

AccessInfo

NameDescriptionTypeExample
activeActive state of accountbooleantrue
openOpen state of accountbooleanfalse
closedReason,nullAn enum describing the reason for closedClosedReason0

Enums

Example Usage

GET /api/v1/accessControl
const headers = new Headers();
headers.append('X-Red-Robin-API-Key', 'API_KEY');
headers.append('Content-Type', 'application/json');

const requestOptions = {
method: 'GET',
headers: headers,
};

fetch('https://se.visibatriage.com/api/v1/accessControl', requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.log('error', error));

Example Success Response

{
"active": true,
"isOpen": true,
"closedReason": 0
}