Skip to main content
GET
Check Service Connection

Endpoint

Overview

Checks the connection status for a specific service. Returns whether the service is connected and entitlement details.

Request

Requires authentication via Bearer token.

Query Parameters

ServiceIdentifier
required
Service identifier: DROP, MAILS, VAULT, or DB

Response

boolean
Whether the service is connected
string
Service identifier
string
Access tier (if entitlement exists)
boolean
Premium access flag (if entitlement exists)

Implementation Details

Code Reference

Status Codes

OK
Success (even if no entitlement found)
Bad Request
Missing or invalid service parameter
Unauthorized
Missing or invalid authentication token

Example Request

Example Response

Connected Service

No Entitlement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

service
enum<string>
required
Available options:
DROP,
MAILS,
VAULT,
DB

Response

200 - application/json

Connection status

connected
boolean
service
enum<string>
Available options:
DROP,
MAILS,
VAULT,
DB
tier
string | null
isPremium
boolean | null