Account & Billing

Who this connection is and what it can reach

Changed on

Confirms the connection works and reports exactly what it can do: the account, the shops in scope, and the granted scopes.

shops is the shops this KEY can reach, which is not always what the account owns — a connector authorized for two shops reports two. Read scopes before attempting a write: a key without read_write gets a 403 from every write endpoint.

Cheap and side-effect free, so it is the right first call to verify a connection rather than a real query that might fail for its own reasons.

get/whoami

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/whoami
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Response

Successful Response

customer_idinteger required

The account this key belongs to.

shop_countinteger required
scopesstring[] required

read always; read_write when the key may create and send.

can_writeboolean required

Convenience mirror of read_write in scopes.

Changes