Listing all API keys of a user account¶

Sends a GET request to the endpoint /user/{id}/api-keys.

Description¶

The List-API-Keys request allows the user to request a list of all API keys of a user account of the organisation.

Requirements¶

Values of the request: User-ID {id}d}

Objects: none

Request¶

To request a list of all API keys of a user account, the User-ID {id} needs to be added to the path of the request.

As a result, the user gets one or more objects ApiKeyVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`key`	The token of the API key.	`string`
`name`	The individual name for the API key.	`string`
`deleted`	Shows if the key was deleted.	`true` `false`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "key": "string",
    "name": "string",
    "deleted": true,
    "id": 0,
    "modified": "2026-01-01T00:00:00+00:00",
    "created": "2026-01-01T00:00:00+00:00"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.