Sign in
API key

Get the current API key

Returns the name and roles of the API key used to authenticate the request. Use this to check which endpoints the key can access.

get/v1/api_key

Response

Successfully returned the API key

namestring required

The name given to the API key when it was created

rolesstring[] required

The roles granted to the API key. admin grants access to every endpoint; event_manager includes event_readonly; order_manager includes order_readonly; customer_data unmasks customer personal data in responses.

Example response

{
  "name": "My integration",
  "roles": [
    "event_readonly",
    "order_readonly"
  ]
}

Changes

Changed in 1 of the 2 revisions of this API.1