Users

Export users

POST export

Endpoint

POST /api/v1/users/export

Parameters

Name Description
passcode required Admin passcode
by_id Users ids to export

Request

Route

POST /api/v1/users/export

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyMDIxIiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzYzNjI2NDE3LCJleHAiOjE3NjYyMTg0MTcsImp0aSI6ImZmZTdiYWI1LTYxZDctNDEyMi04YWI3LTAyMGI5NjU2OTM1ZiJ9.nbUEX3pqhpwMsx-ckO6Xz9N0RurmtqfjyUzOq1g3yHI
Host: example.org
Cookie: 

Body

{
  "passcode": 1234,
  "by_id": [
    2016,
    2017,
    2018,
    2019,
    2020
  ]
}

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: text/csv
content-disposition: attachment; filename="users-report-2025-11-20.csv"; filename*=UTF-8''users-report-2025-11-20.csv
content-transfer-encoding: binary
vary: Accept, Origin
etag: W/"96144cb2fccd625d1de6a2b54d779826"
cache-control: max-age=0, private, must-revalidate
x-request-id: 43125158-db93-430c-a4a2-77d8e82bf52c
x-runtime: 0.006376
content-length: 383

Body

id,email,first_name,last_name,postcode,licenses,english_level,region,birth_date,start_date,contact_phone_number
2016,gus.lueilwitz+10@example.com,Gus,Lueilwitz,,,,,,,
2017,micheal.strosin+10@example.com,Micheal,Strosin,,,,,,,
2018,alberta.hand+10@example.com,Alberta,Hand,,,,,,,
2019,frank.johns+10@example.com,Frank,Johns,,,,,,,
2020,vida.ziemann+10@example.com,Vida,Ziemann,,,,,,,