List all of your ApiTokens

GET/users/self/api-tokens/

API version

v2

Request method

GET

Operation ID

user-list-api-tokens

---

Request

Responses

Response headers

• X-Pagination-Limitnumber

  The limit used to select the resources for the response

• X-Pagination-Skipnumber

  The number of skipped items

• X-Pagination-Pagenumber

  The calculate page of the list response. Refer to parameters to learn more.

• X-Pagination-TotalCountnumber

  The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Description

A list of ApiTokens.

Schema documentation

• Array[
• *object
  • apiTokenIdstring (uuid)

    required
  • createdAtstring (date-time)

    required
  • descriptionstring

    required
  • expiresAtstring (date-time)
  • rolesarray of string (one of: api_read, api_write)

    required
    • Array[
    • *string (one of: api_read, api_write)
    ]
]

Example

[
  {
    "apiTokenId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "createdAt": "2025-04-07T16:10:22.867Z",
    "description": "Api Token - read",
    "expiresAt": "2025-04-07T16:10:22.867Z",
    "roles": [
      "api_read"
    ]
  }
]

JSON Schema

{
  "items": {
    "properties": {
      "apiTokenId": {
        "format": "uuid",
        "type": "string"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "description": {
        "example": "Api Token - read",
        "type": "string"
      },
      "expiresAt": {
        "format": "date-time",
        "type": "string"
      },
      "roles": {
        "items": {
          "enum": [
            "api_read",
            "api_write"
          ],
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "apiTokenId",
      "roles",
      "description",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/users/self/api-tokens?limit=50&page=1

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.listApiTokens({
  "queryParameters": {
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\ListApiTokens\ListApiTokensRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListApiTokensRequest())
  ->withLimit(50)
  ->withPage(1);
$response = $client->user()->listApiTokens($request);

var_dump($response->getBody();