---
title: "Export user API keys to CSV"
method: GET
path: "/api/v1/user-api-keys/export/csv"
tags: ["User API Keys", "internal"]
---

# Export user API keys to CSV

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

## Request

- Base URL: `https://app.scanopy.net`
- URL: `https://app.scanopy.net/api/v1/user-api-keys/export/csv`
- Auth: one of:
  - API key in header `Authorization`
  - API key in cookie `session_id`

Export all user API keys matching the filter criteria to CSV format. Ignores pagination parameters (limit/offset) and exports all matching records.

## 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`

CSV file containing User API Keys

## Changes

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

[Operation history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/user-api-keys/export/csv/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)
