Skip to navigation

Retrieve your organization

View as Markdown

The organization the key belongs to, the key’s own details (its id, label, scopes and the customer it is limited to), and how many customers, locations and printers the key can see. Any valid key may call it.

Scope: none. Any valid key may call this.

Authentication

AuthorizationBearer

A restricted API key, tc_rk_live_ and 32 characters. Send it as Authorization: Bearer <key>. A key lists its scopes, and each operation below names the one it needs; a key may also be limited to one customer. An owner or a developer of the organization makes a key in the dashboard, under API keys, after a code sent to their e-mail. The key is shown once, when it is made. An owner or a developer can revoke it there, and a revoked key stops working within a minute.

Response

The organization and the key.
api_keyobject
The key that made the request.
customerslong>=0

What the key can see: the organization’s, or, for a key limited to one customer, that customer’s.

idstring
locationslong>=0
namestring
objectstring
printerslong>=0
statestring

active, suspended or offboarding.

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error