api-keys

Version 0.1.03 operations

List the API keys of the organisation (prefixes and labels only)

GET/organisations/{id}/api-keysDashboard session

Parameters

idstringpathrequired

Responses

200
- idstring (uuid)required
- prefixstringrequired
- labelstring | nullrequired
- createdAtstring (date-time)required
- lastUsedAtstring (date-time) | nullrequired
- revokedAtstring (date-time) | nullrequired
- createdBystring (uuid) | nullrequired

Code samples

curl -X GET "$KONNECT_API_URL/organisations/id/api-keys" \
  -H "Cookie: konnect_session=$KONNECT_SESSION"

Example: 200

[
  {
    "id": "id",
    "prefix": "prefix",
    "label": "label",
    "createdAt": "2026-10-01T09:30:00.000Z",
    "lastUsedAt": "2026-10-01T09:30:00.000Z",
    "revokedAt": "2026-10-01T09:30:00.000Z",
    "createdBy": "createdBy"
  }
]

Create an API key; the full key is returned once

POST/organisations/{id}/api-keysDashboard session

Parameters

idstringpathrequired

Request body application/json

labelstring

Responses

201
- idstring (uuid)required
- prefixstringrequired
- labelstring | nullrequired
- createdAtstring (date-time)required
- lastUsedAtstring (date-time) | nullrequired
- revokedAtstring (date-time) | nullrequired
- createdBystring (uuid) | nullrequired
- keystringrequired
  Full key <prefix>:<secret>, shown once

Code samples

curl -X POST "$KONNECT_API_URL/organisations/id/api-keys" \
  -H "Cookie: konnect_session=$KONNECT_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "WooCommerce shop"
}'

Example: request body

{
  "label": "WooCommerce shop"
}

Example: 201

{
  "id": "id",
  "prefix": "prefix",
  "label": "label",
  "createdAt": "2026-10-01T09:30:00.000Z",
  "lastUsedAt": "2026-10-01T09:30:00.000Z",
  "revokedAt": "2026-10-01T09:30:00.000Z",
  "createdBy": "createdBy",
  "key": "key"
}

Revoke an API key (kept for history)

DELETE/organisations/{id}/api-keys/{keyId}Dashboard session

Parameters

idstringpathrequired
keyIdstringpathrequired

Responses

200
- idstring (uuid)required
- prefixstringrequired
- labelstring | nullrequired
- createdAtstring (date-time)required
- lastUsedAtstring (date-time) | nullrequired
- revokedAtstring (date-time) | nullrequired
- createdBystring (uuid) | nullrequired

Code samples

curl -X DELETE "$KONNECT_API_URL/organisations/id/api-keys/keyId" \
  -H "Cookie: konnect_session=$KONNECT_SESSION"

Example: 200

{
  "id": "id",
  "prefix": "prefix",
  "label": "label",
  "createdAt": "2026-10-01T09:30:00.000Z",
  "lastUsedAt": "2026-10-01T09:30:00.000Z",
  "revokedAt": "2026-10-01T09:30:00.000Z",
  "createdBy": "createdBy"
}