---
title: "Export user data (GDPR)"
url: https://hexelstudio.com/docs/api/ciam-core/users/export
---

# Export user data (GDPR)

**GET** `/users/{user_id}/export`

## Path parameters

- `user_id: string`

  User ID

## Headers

- `Authorization: string`

  `Bearer <token>`.

## Returns

`200` OK (`UserExportResponse`)

- `user: optional User`

  - `avatar_url: optional string`

  - `created_at: optional string`

  - `deleted_at: optional DeletedAt`

    - `time: optional string`

    - `valid: optional boolean`

      Valid is true if Time is not NULL

  - `deletion_requested_at: optional string`

  - `deletion_scheduled_for: optional string`

  - `display_name: optional string`

  - `email: optional string`

  - `email_verified_at: optional string`

  - `external_identities: optional array of integer`

    IDP mappings

  - `first_name: optional string`

  - `id: optional string`

  - `identity_issuer: optional string`

  - `identity_tenant_id: optional string`

  - `is_active: optional boolean`

  - `is_email_verified: optional boolean`

  - `is_phone_verified: optional boolean`

  - `is_platform_admin: optional boolean`

  - `last_login_at: optional string`

  - `last_name: optional string`

  - `locale: optional string`

  - `locked_at: optional string`

  - `locked_reason: optional string`

  - `name: optional string`

  - `onboarding_status: optional string`

    REGISTERED, PHONE_VERIFIED, ORG_CREATED, ONBOARDING_COMPLETE

  - `phone_number: optional string`

  - `phone_verified_at: optional string`

  - `profile_image_url: optional string`

  - `status: optional string`

    ACTIVE, SUSPENDED, LOCKED, DEACTIVATED

  - `suspended_at: optional string`

  - `suspended_by_user_id: optional string`

  - `suspension_reason: optional string`

  - `timezone: optional string`

  - `updated_at: optional string`

  - `verification_version: optional integer`

## Errors

- `404` Not Found

## Example

```bash
curl --request GET \
  --url 'https://api.hexelstudio.com/v1/users/{user_id}/export' \
  --header "Authorization: Bearer $ACCESS_TOKEN"
```

### Response (200)

```json
{
  "user": {
    "avatar_url": "string",
    "created_at": "2026-01-01T00:00:00Z",
    "deleted_at": {
      "time": "string",
      "valid": true
    },
    "deletion_requested_at": "2026-01-01T00:00:00Z",
    "deletion_scheduled_for": "string",
    "display_name": "string",
    "email": "string",
    "email_verified_at": "2026-01-01T00:00:00Z",
    "external_identities": [
      0
    ],
    "first_name": "string",
    "id": "string",
    "identity_issuer": "string",
    "identity_tenant_id": "string",
    "is_active": true,
    "is_email_verified": true,
    "is_phone_verified": true,
    "is_platform_admin": true,
    "last_login_at": "2026-01-01T00:00:00Z",
    "last_name": "string",
    "locale": "string",
    "locked_at": "2026-01-01T00:00:00Z",
    "locked_reason": "string",
    "name": "string",
    "onboarding_status": "string",
    "phone_number": "string",
    "phone_verified_at": "2026-01-01T00:00:00Z",
    "profile_image_url": "string",
    "status": "string",
    "suspended_at": "2026-01-01T00:00:00Z",
    "suspended_by_user_id": "string",
    "suspension_reason": "string",
    "timezone": "string",
    "updated_at": "2026-01-01T00:00:00Z",
    "verification_version": 0
  }
}
```

### Response (404)

```json
{
  "key": "string"
}
```