Skip to main content
GET
Export user role groups as CSV

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:500

The number of items per page

Required range: 0 <= x <= 500
pagination
boolean

Enable or disable pagination

unit
string
unit[]
string[]
user.type
string
user.type[]
string[]
user.status
string
user.status[]
string[]
user.townCurrent
string
user.townCurrent[]
string[]
user.professionIndustry
string
user.professionIndustry[]
string[]
user.townCurrent.country
string
user.townCurrent.country[]
string[]
exists[user.isFullMember]
boolean
order[user.localCenter.name]
enum<string>
default:asc
Available options:
asc,
desc
order[user.townCurrent.name]
enum<string>
default:asc
Available options:
asc,
desc
order[user.dateBirth]
enum<string>
default:asc
Available options:
asc,
desc
order[user.status]
enum<string>
default:asc
Available options:
asc,
desc
order[user.lastName]
enum<string>
default:asc
Available options:
asc,
desc
order[user.type.position]
enum<string>
default:asc
Available options:
asc,
desc
order[user.isFullMember]
enum<string>
default:asc
Available options:
asc,
desc
north
number

Northern latitude boundary (requires south, east, west)

south
number

Southern latitude boundary (requires north, east, west)

east
number

Eastern longitude boundary (requires north, south, west)

west
number

Western longitude boundary (requires north, south, east)

clusterLat
number

Filter by cluster latitude (requires clusterLng and clusterPrecision)

clusterLng
number

Filter by cluster longitude (requires clusterLat and clusterPrecision)

clusterPrecision
integer

Cluster precision (decimal places for rounding)

feeStatus
string

Filter by user fee payment status: "paid" or "not_paid"

Response

UserUnitRoleGroup collection

user
object