# Export users as CSV

`GET /v1/admin/users/export.csv`

URL: https://docs.spacerun.co/docs/platform/reference/users/exportAdminUsersCsv

- **Operation ID:** `exportAdminUsersCsv`
- **Tags:** Users
- **Base URL:** `http://localhost:8787`

Same filters as the list. Only the first 100 matching rows are exported (`page` and `per_page` are ignored). Columns: id,email,username,display_name,status,tier,created_at,last_seen_at,roles (roles joined with `|`). Served as an attachment named `users.csv`.

**Workflow:** [Integration guide](https://docs.spacerun.co/docs/platform/guides/staff-permissions).

**Authentication:** staff Bearer JWT with permission `users.read`.

## Authentication

- **Auth:** staff Bearer JWT (`Authorization: Bearer <access_token>`) with the permissions below.
- **Required permissions:** `users.read`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `q` | query | `string` | no | Min length: 1. Max length: 200 |
| `status` | query | `string` | no | One of: `"active"`, `"banned"`, `"deleted"` |
| `tier` | query | `string` | no | Min length: 1. Max length: 32 |
| `role` | query | `string` | no | Min length: 1. Max length: 48 |
| `provider` | query | `string` | no | Min length: 1. Max length: 32 |
| `has_subscription` | query | `boolean` | no | - |
| `created_from` | query | `string<date-time>` | no | - |
| `created_to` | query | `string<date-time>` | no | - |
| `last_seen_from` | query | `string<date-time>` | no | - |
| `last_seen_to` | query | `string<date-time>` | no | - |
| `sort` | query | `string` | no | One of: `"created_at:asc"`, `"created_at:desc"`, `"last_seen_at:asc"`, `"last_seen_at:desc"`. Default: `"created_at:desc"` |
| `page` | query | `integer` | no | Default: `1`. Greater than: 0 |
| `per_page` | query | `integer` | no | Default: `25`. Greater than: 0. Max: 100 |

## Responses

### 200

CSV file.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
- Header `Content-Disposition`: Download filename. Example: `"attachment; filename=\"users.csv\""`.
Content type: `text/csv`

Schema: `string`

## Errors

### 400

Request validation failed.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ValidationErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | `boolean` | yes | One of: `false` |
| `error` | `object` | yes | - |
| `error.name` | `string` | yes | One of: `"ZodError"` |
| `error.issues` | `object[]` | yes | - |
| `error.issues[].code` | `string` | yes | - |
| `error.issues[].path` | `(string \| number)[]` | yes | - |
| `error.issues[].message` | `string` | yes | - |

**Request validation**

```json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}
```

### 401

Missing, malformed, expired or wrong-audience Bearer token (`missing_token`, `invalid_token`, `invalid_audience`).

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | `string` | yes | Stable machine-readable error code, e.g. `forbidden`, `not_found`. |
| `details` | `any` | no | Optional structured context. For 403 it is `{ perm }`. |

**Error response**

```json
{
  "error": "missing_token"
}
```

### 403

Authenticated but lacking the required permission. `details.perm` lists the accepted permission keys.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "forbidden",
  "details": {
    "perm": "users.read"
  }
}
```

### 500

Unexpected server error (`internal`). No details are returned.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "internal"
}
```

## Examples

### curl

```bash
curl -X GET 'http://localhost:8787/v1/admin/users/export.csv' \
  -H "Authorization: Bearer $ACCESS_TOKEN"
```

### TypeScript

```ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/users/export.csv", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();
```