API Reference
Ping
Verifies your API key is valid and returns publisher identity + key metadata. Use this as a health check and to confirm your integration is wired up correctly before building further.
GET
/pub_api/v3/ping
any scope
▶ Run in console
Request
No query parameters. No request body. Just the auth header.
Response fields
FieldTypeDescription
status
string
Always
"ok"
version
string
API version string, e.g.
"3.0"
publisher.id
integer
Your Cuelinks internal user ID.
publisher.name
string
Your display name on the platform.
publisher.email
string
Your registered email address.
publisher.publisher_id
string
Your public publisher identifier.
publisher.currency
string
Your account's reporting currency —
"INR" or "USD". This is the unit every money field elsewhere in the API is denominated in, so you can read it once at startup rather than inferring it. Never null — an account with no currency set reads as "INR".
api_key.name
string
The name you gave this key when creating it.
api_key.scopes
string[]
Array of permission scopes on this key. Null for legacy keys (full access).
api_key.last_used_at
datetime
ISO 8601 timestamp of when this key was last used.
Request
curl https://developers.cuelinks.com/pub_api/v3/ping \ -H "Authorization: Token YOUR_API_KEY"
200 OK
200
{ "status": "ok", "version": "3.0", "publisher": { "id": 8421, "name": "Acme Publishers", "email": "[email protected]", "publisher_id": "PUB8421", "currency": "INR" }, "api_key": { "name": "Production Key", "scopes": ["read:campaigns"], "last_used_at": "2026-03-23T08:00:00Z" } }