Sign in

v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Health

Check connectivity

Verifies your key and returns the resolved partner and mode. The first call of every integration.

get/ping

Response

Key is valid.

oktrue required
mode'test' | 'live' required

Example response

{
  "partner": {
    "id": "prt_7f3e9a2c54d1",
    "name": "Example HR"
  }
}