latestOpenAPI 3.0.02026-08-10747104.4 KB

9d798e339d22

Info

Get API key information.

Get information about your API key, such as the enabled scopes and shopId which it is associated with.

get/info

Response

API key info

labelstring required

The human-readable label of this API key

keyIdstring required

The unique ID of this API key

shopIdstring required

The ID of the shop this key is associated with

scopesstring[] required

The access scopes enabled for this key

rateLimitUsednumber required

How many calls have been made with this key against the rate limit. Please note that this value is periodically decreased.

rateLimitMaxnumber required

How many calls can be made, in total, before being rate limited.

Example response

{
  "label": "My API key",
  "keyId": "v9ZUBQbs8ds3Wr0shFaA",
  "shopId": "vDO2HA2EVk8OifGimZxu",
  "scopes": [
    "read:products",
    "create:orders"
  ],
  "rateLimitUsed": 100,
  "rateLimitMax": 1000,
  "rateLimitRemaining": 900
}