---
title: "List user API keys"
method: GET
path: "/api/v1/user-api-keys"
tags: ["User API Keys", "internal"]
---

# List user API keys

`GET /api/v1/user-api-keys`

## Request

- Base URL: `https://app.scanopy.net`
- URL: `https://app.scanopy.net/api/v1/user-api-keys`
- Auth: API key in cookie `session_id`

The signed-in user's keys.

## Query parameters

- `permissions` UserOrgPermissions[], nullable
- `site_ids` string[], nullable
- `is_enabled` boolean[], nullable
- `tag_ids` string[], nullable
- `tag_sets` string[], nullable
- `search` string, nullable
- `group_by` 'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at': Fields the user API key list can be ordered and grouped by.
- `order_by` 'created_at' | 'name' | 'updated_at' | 'permissions' | 'is_enabled' | 'last_used' | 'expires_at': Fields the user API key list can be ordered and grouped by.
- `group_by_tag_group` string, uuid, nullable
- `order_by_tag_group` string, uuid, nullable
- `order_direction` 'asc' | 'desc': Direction for ORDER BY clauses.
- `limit` integer, nullable
- `offset` integer, nullable

## Response `200`

List of user API keys

- PaginatedApiResponseUserApiKey: Response type for paginated list endpoints (pagination is always present in meta)
  - `data` object[], required: The page of results. Empty when nothing matched the query.
    - `expires_at` string, date-time, nullable: When this record stops being valid.
    - `is_enabled` boolean: Whether the key may still be used. Disabled keys are rejected.
    - `key` string, required: The stored key. Returned redacted except on creation and rotation.
    - `last_used` string, date-time, nullable, required: When this key was last used to authenticate.
    - `name` string, required: Human-facing name for this key.
    - `organization_id` string, uuid, required: The organization that owns this record.
    - `permissions` 'Owner' | 'Admin' | 'Member' | 'Viewer'
    - `site_ids` string[]: Site IDs this key has access to (hydrated from junction table)
    - `tags` string[], required: Tags assigned to this entity.
    - `user_id` string, uuid, required: User the key acts on behalf of.
    - `created_at` string, date-time, required: When this record was first created.
    - `id` string, uuid, required: Server-assigned unique identifier.
    - `updated_at` string, date-time, required: When this record was last modified.
  - `error` string, nullable: Human-readable failure message. Omitted on success.
  - `meta` PaginatedApiMeta, required: API metadata for paginated list responses (pagination is always present)
    - `api_version` integer, required: API version (integer, increments on breaking changes)
    - `pagination` PaginationMeta, required: Pagination metadata returned with paginated responses.
      - `group_counts` GroupCount[], nullable: Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped.
        - `count` integer, required: How many rows fall in this group in total, not just on this page.
        - `value` string, nullable: The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket).
      - `has_more` boolean, required: Whether there are more items after this page
      - `limit` integer, required: Maximum items per page (as requested)
      - `offset` integer, required: Number of items skipped
      - `total_count` integer, required: Total number of items matching the filter (ignoring pagination)
    - `server_version` string, required: Server version (semver)
  - `success` boolean, required: `true` when the request succeeded. `false` responses carry `error` instead of `data`.

## Other responses

- `401`: Not authenticated
- `500`: Internal server error

## Changes

- **2026-10-26** `c9d9d46d1ae8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/user-api-keys/get.md)

---

[API](https://skmtc.dev/scanopy/apis/scanopy-api.md) - [All operations](https://skmtc.dev/scanopy/apis/scanopy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scanopy/apis/scanopy-api/revisions/966ba786bdb5?raw)