DEVELOPERS / 05
Build with a
governed API.
Integrate with Viresco through secure, documented interfaces for connection management, data exchange, and operational visibility.
Viresco API
Use the API to manage authorized connections and review operational state from your applications and internal tools.
!
Access is provisioned per environment
API credentials, scopes, and available endpoints are configured for each deployment. Request access to receive environment-specific documentation.
Authentication
Authenticate API requests with a provisioned bearer token. Keep credentials in a secure secret store and send requests over HTTPS.
HTTP / AUTHENTICATION
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Accept: application/jsonExample request
Retrieve the status of a connection available to your environment.
GET /V1/CONNECTIONS/{ID}
curl --request GET \
--url https://api.viresco.example/v1/connections/{id} \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Accept: application/json'200 ยท APPLICATION/JSON
{
"id": "con_7f24b8",
"status": "operational",
"last_sync_at": "2026-10-05T12:08:00Z",
"environment": "production"
}Endpoint groups
GET/v1/connectionsList configured connections
GET/v1/connections/{id}Retrieve connection status
POST/v1/routes/{id}/validateValidate route payload
GET/v1/eventsReview available events
Illustrative examples for product evaluation. Endpoint availability and schemas are deployment-specific; request access for current documentation.
FOR INTEGRATION TEAMS