Get health

Get information about the health of the API. Useful to verify if the API is reachable and you can successfully authenticate against it.

GET /partner/v1/health

Get health

cURL

curl --request GET \
  --url https://www.venturu.com/api/partner/v1/health \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "success",
  "permissions": [
    "<string>"
  ],
  "timestamp": "<string>"
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

Successful response

status · enum<string> · required

Indicates that you can successfully connect to the API.

Available options: success

permissions · string[] · required

The permissions granted to the key.

timestamp · string · required

The current server timestamp in ISO 8601 format.