Skip to Content
Developers
Connection

Get the connection

GET
/connection

The brand, platform, mode and status of the connection the key belongs to. Call it first to check a key.

Authorization

integrationKey
headerAuthorizationBearer <token>

A brand integration key, created by an Owner or Admin in Brand Settings › Integrations and shown once. endvr_ik_test_… keys write test data that is never billed; endvr_ik_live_… keys are live.

Response Body

The connection.

application/json
  1. response
brandId*string
brandName*string
platform*string

The e-commerce platform chosen when the key was created.

Example"woocommerce"
mode*Mode

test for data written with a test key, live otherwise.

Value in"test""live"
status*string

waiting_first_event until the first call that writes data; error when webhooks keep failing; paused when the brand paused the connection in the portal.

Value in"connected""waiting_first_event""error""paused"
lastEventAt*|
Formatdate-time
Example Request
curl -X GET 'https://api.endvr.io/v1/connection'
Example Response
{  "brandId": "string",  "brandName": "string",  "platform": "woocommerce",  "mode": "test",  "status": "connected",  "lastEventAt": "2019-08-24T14:15:22Z"}