Skip to main content
GET
Check your API key

Authorizations

Authorization
string
header
required

Send your key in the Authorization header: Authorization: Bearer hk_live.…. The word Bearer is case-sensitive.

Keys are issued by Hoppier during the beta and shown once. Treat them like passwords and never put one in code that runs in a browser or an app.

Response

The key works.

connectionId
string
required

The key's public prefix. Safe to log and to show as a connection label.

Example:

"1a2b3c4d"

email
string | null
required

Email of the admin the key belongs to.

Example:

"admin@example.com"

company
string
required

Name of the company the key belongs to.

Example:

"Acme Inc."

keyType
enum<string>
required

Every key issued today is user, a personal key. Company keys are coming soon.

Available options:
user,
company
message
string
required
Allowed value: "OK"