---
updatedAt: 2026-05-28T08:16:45.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# Get Access Token Usage

This endpoint returns a list of access token usage on the account.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "AccessTokenUsage": {
        "description": "Represents the access token item.",
        "properties": {
          "attributes": {
            "properties": {
              "created-at": {
                "description": "The time when the token was created.",
                "format": "date-time",
                "type": "string"
              },
              "description": {
                "description": "The description of the token.",
                "maxLength": 255,
                "nullable": true,
                "type": "string"
              },
              "expires-at": {
                "description": "The UTC expiration datetime.",
                "format": "date-time",
                "nullable": true,
                "type": "string"
              },
              "last-characters": {
                "description": "The last 6 characters of the token",
                "maxLength": 512,
                "type": "string"
              },
              "last-used-at": {
                "description": "The time when the token was last used.",
                "format": "date-time",
                "nullable": true,
                "type": "string"
              },
              "name": {
                "description": "The name of the token.",
                "maxLength": 64,
                "nullable": true,
                "type": "string"
              },
              "owner-email": {
                "type": "string"
              },
              "owner-status": {
                "enum": [
                  "Active",
                  "Inactive",
                  "Pending"
                ],
                "type": "string"
              },
              "owner-type": {
                "enum": [
                  "user",
                  "service-account"
                ],
                "type": "string"
              }
            },
            "type": "object"
          },
          "id": {
            "readOnly": true,
            "type": "string"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "type": {
            "enum": [
              "access-token-usages"
            ],
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "AccessTokenUsageListingDocument": {
        "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/AccessTokenUsage"
            },
            "type": "array"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "readOnly": true,
            "type": "object"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/reports/access-tokens": {
      "get": {
        "description": "This endpoint returns a list of access token usage on the account.",
        "operationId": "list_access_token_usage",
        "parameters": [
          {
            "description": "Format of the response. It can be 'json' or 'csv'.",
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Returns tokens by expiration status",
            "in": "query",
            "name": "filter[is-expired]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter tokens by owner identity status (user or service account). Allowed values: Active, Inactive.",
            "in": "query",
            "name": "filter[user][status]",
            "required": false,
            "schema": {
              "enum": [
                "Active",
                "Inactive"
              ],
              "type": "string"
            }
          },
          {
            "description": "Filter tokens by creation date.",
            "in": "query",
            "name": "filter[created-at]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page number.",
            "in": "query",
            "name": "page[number]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page size.",
            "in": "query",
            "name": "page[size]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Query by token and user email",
            "in": "query",
            "name": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The comma-separated list of attributes.",
            "explode": false,
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "items": {
                "enum": [
                  "created-at",
                  "expires-at",
                  "last-used-at",
                  "owner-email"
                ],
                "type": "string"
              },
              "type": "array"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessTokenUsageListingDocument"
                }
              },
              "text/csv": {
                "schema": {
                  "format": "csv",
                  "type": "string"
                }
              }
            },
            "description": "Success."
          },
          "403": {
            "description": "User unauthorized to perform this action."
          },
          "404": {
            "description": "Access token usage not found or user unauthorized to perform action."
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "Get Access Token Usage",
        "tags": [
          "access-token-usage"
        ],
        "x-mcp-tool": true,
        "x-resource": "AccessTokenUsage",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```