Skip to content
Subako Docs
Esc
↑↓navigate↵open⌘Jpreview

GET /v1/api-keys

GET/v1/api-keys
Authorization
AuthorizationBearer token · headerrequired
Query parameters
limitinteger<int64>
min 1 · max 200
afterstring<uuid>
orderOrderParam
Newest first when omitted.
Allowed:ascdesc
Header parameters
Kikuvi-Workspacestring<uuid>required
Workspace to list from
Responses
200One page, newest first unless order=asc. A revoked key still appears, with its revoked_at set.
itemsApiKeyBody[]required
Show properties
Array of ApiKeyBody
created_atstring<date-time>required
created_byActorBodyrequired
Who did something, resolved for display. `users` rows are never deleted, so this renders after a membership ends.
Show properties
display_namestring | nullrequired
primary_emailstring | nullrequired
user_idstring<uuid>required
expires_atstring<date-time> | nullrequired
idstring<uuid>required
labelstringrequired
last_used_atstring<date-time> | nullrequired
permissionsKeyPermissionSchema[]required
prefixstringrequired
Non-secret display prefix: the key's marker, its environment, and eight characters of the secret.
revoked_atstring<date-time> | nullrequired
next_cursorstring<uuid> | nullrequired
`None` on the last page.
400Bad limit, cursor, or order, a malformed workspace header, or no workspace header.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
401Missing, malformed, or invalid bearer token.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
404No such workspace, or the caller cannot see it.
errorErrorDetailrequired
Show properties
codeErrorCoderequired
The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.
Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.us.cloud.subako.ai/v1/api-keys" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Kikuvi-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08"
Response
{
  "items": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "display_name": "string",
        "primary_email": "string",
        "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
      },
      "expires_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "last_used_at": "2019-08-24T14:15:22Z",
      "permissions": [
        "workspace.read"
      ],
      "prefix": "string",
      "revoked_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "a7ec8888-a9c3-4732-a281-9a08510f220b"
}