KeyEnvKeyEnv
API Reference

Account

GDPR and account management

Account

GDPR and account management

Get data export status

GET /api/v1/account/data-export

Returns the status of a pending data export request

Operation ID: getDataExportStatus · Authentication: Authorization: Bearer <token>

Responses

StatusDescriptionBody
200Export statusDataExportStatusResponse
401Authentication requiredError

Response body (200)

FieldTypeDescription
statusenum (none, pending, ready, expired)
requested_atstring (date-time)
expires_atstring (date-time)

Example

curl -X GET "https://api.keyenv.dev/api/v1/account/data-export" \
  -H "Authorization: Bearer $KEYENV_TOKEN"

Request data export

POST /api/v1/account/data-export/request

Requests a GDPR data export

Operation ID: requestDataExport · Authentication: Authorization: Bearer <token>

Responses

StatusDescriptionBody
200Export requestedDataExportRequestResponse
401Authentication requiredError
409Resource already existsError

Response body (200)

FieldTypeDescription
statusstring
messagestring

Example

curl -X POST "https://api.keyenv.dev/api/v1/account/data-export/request" \
  -H "Authorization: Bearer $KEYENV_TOKEN"

Download data export

GET /api/v1/account/data-export/download

Downloads the completed data export

Operation ID: downloadDataExport · Authentication: Authorization: Bearer <token>

Responses

StatusDescriptionBody
200Export dataUserDataExport
401Authentication requiredError
404Resource not foundError

Response body (200)

FieldTypeDescription
userobject
teamsobject[]
exported_atstring (date-time)

Example

curl -X GET "https://api.keyenv.dev/api/v1/account/data-export/download" \
  -H "Authorization: Bearer $KEYENV_TOKEN"

Delete account

DELETE /api/v1/account

Permanently deletes the user account and all associated data

Operation ID: deleteAccount · Authentication: Authorization: Bearer <token>

Request body

application/json (required)

FieldTypeRequiredDescription
confirmationstringyesMust be "DELETE"

Responses

StatusDescriptionBody
200Account deletedDeleteAccountResponse
400Invalid requestError
401Authentication requiredError

Response body (200)

FieldTypeDescription
successboolean
messagestring

Example

curl -X DELETE "https://api.keyenv.dev/api/v1/account" \
  -H "Authorization: Bearer $KEYENV_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"confirmation":"string"}'

On this page