Export users

POST

/api/v1/users/export

const url = 'http://localhost:3000/api/v1/users/export';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"format":"csv","organizationId":"example","active":true,"userIds":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/users/export \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "format": "csv", "organizationId": "example", "active": true, "userIds": [ "example" ] }'

Exports users to CSV or JSON format. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Request Body^required

application/json

object

format

Export format

string

default: csv

Allowed values: csv json

organizationId

Filter by organization ID

string

active

Filter by active status

boolean

userIds

Specific user IDs to export

Array<string>

Responses

200

Users exported successfully

401

Unauthorized

403

Forbidden - Super Admin required