Skip to main content
GET
Export customers
The file format goes in the type query parameter: ?type=csv (the default) answers a UTF-8 CSV file, ?type=xlsx an Excel workbook returned base64-encoded. The file lists every customer of the organization, whatever its status, one per row, with four columns whose headers are in Portuguese: Nome do cliente (name), CPF/CNPJ (document), Status (Ativo or Desativado) and Data de Criação (creation date, as DD/MM/YYYY, the UTC date: a customer created at 22:30 in Brasília time on the 13th shows the 14th). The filters of the customer list do not apply.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose customers you want to export.

Format: UUID

Query Parameters

type
enum<string>
default:csv

The file format: csv for a UTF-8 CSV file (the default), xlsx for an Excel workbook returned base64-encoded.

Available options:
csv,
xlsx

Response

application/csv — The customers as a UTF-8 CSV file, when type is csv or omitted (served with that Content-Type).

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet — The Excel workbook, base64-encoded, when type is xlsx.

The customers as a UTF-8 CSV file, when type is csv or omitted (served with that Content-Type).