Skip to navigation

Retrieve a customer

View as Markdown

A customer of your organization, with the number of its locations and printers.

Scope: customers:read.

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.

Path parameters

customerstringRequired
The customer's id.

Response

The customer.
client_reference_idstring or null

The id of this customer in your own system, or null. Not unique: the same value can be on many objects, and GET /v1/customers?client_reference_id= lists every customer that carries it.

created_atstring
idstring

cus_ and the customer’s code, which is also the first label of the host of its printers.

location_countlong>=0
modestring

live.

namestring
objectstring
printer_countlong>=0
statestring

active, or suspended (its printers print nothing).

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error