Get the key's details

GET/api/v1

Which workspace the key applies to, who it acts as and what it is allowed to do. Useful for testing the connection.

Scope

All valid keys.

Response

200 The key's details.

api_versionstringrequired
workspaceobjectrequired
workspace.idstringrequired
workspace.namestringrequired
keyobjectrequired
key.idstringrequired
key.namestringrequired
key.prefixstringrequired
key.scopesarray<string>required
acting_asobjectrequired: The person the key acts as, and their role in the workspace right now. For Qrona's system key, id is null.
acting_as.idstring | nullrequired
acting_as.namestring | nullrequired
acting_as.rolestringrequired: owneradmineditorviewer

Errors

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
429: rate_limited
500: internal_error

Request

curl 'https://newsletter.qrona.se/api/v1' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY"

Response 200

{
  "api_version": "1",
  "workspace": {
    "id": "0b8f…",
    "name": "Example Ltd"
  },
  "key": {
    "id": "5d1e…",
    "name": "Webbutiken (WooCommerce)",
    "prefix": "qn_live_AbCd",
    "scopes": [
      "contacts:read",
      "contacts:write",
      "fields:read",
      "lists:read"
    ]
  },
  "acting_as": {
    "id": "7a2c…",
    "name": "Anna Svensson",
    "role": "admin"
  }
}