Skip to main content
GET
Export users 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

customFieldValues.value
string
customFieldValues.value[]
string[]
customFieldValues.field
string
customFieldValues.field[]
string[]
townCurrent.country
string
townCurrent.country[]
string[]
email
string
email[]
string[]
feeTenantProductPrice
string
feeTenantProductPrice[]
string[]
cardId
string
status
string
status[]
string[]
type
string
type[]
string[]
firstName
string
lastName
string
townCurrent
string
townCurrent[]
string[]
professionIndustry
string
professionIndustry[]
string[]
professionHeadline
string
roles
string
localCenter
string
localCenter[]
string[]
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[dateBirth]
enum<string>
default:asc
Available options:
asc,
desc
order[dateUpdated]
enum<string>
default:asc
Available options:
asc,
desc
order[dateJoined]
enum<string>
default:asc
Available options:
asc,
desc
order[lastName]
enum<string>
default:asc
Available options:
asc,
desc
order[validFeeDate]
enum<string>
default:asc
Available options:
asc,
desc
order[status]
enum<string>
default:asc
Available options:
asc,
desc
order[type.position]
enum<string>
default:asc
Available options:
asc,
desc
order[isFullMember]
enum<string>
default:asc
Available options:
asc,
desc
order[localCenter.name]
enum<string>
default:asc
Available options:
asc,
desc
order[townCurrent.name]
enum<string>
default:asc
Available options:
asc,
desc
order[professionUpdateDate]
enum<string>
default:asc
Available options:
asc,
desc
order[cardId]
enum<string>
default:asc
Available options:
asc,
desc
exists[professionIndustry]
boolean
exists[professionHeadline]
boolean
exists[isFullMember]
boolean
exists[userRoles.dateEnded]
boolean
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 users by cluster latitude (requires clusterLng and clusterPrecision)

clusterLng
number

Filter users by cluster longitude (requires clusterLat and clusterPrecision)

clusterPrecision
integer

Cluster precision (decimal places for rounding)

keyword
string
feeStatus
string

Filter by fee payment status: "paid", "not_paid", or "grace_period"

paidOrPermission
string

Filter users who are paid members or have any permission

Response

User collection

id
integer
read-only
firstName
string | null
Maximum string length: 255
lastName
string | null
Maximum string length: 255
email
string<email> | null
status
string
gender
string | null
localCenter
object | null
type
object | null
age
integer | null
read-only
isFeeActive
boolean
read-only
isExpiredValidFeeDate
boolean
read-only
dateJoinedFullMemberFormatted
string | null
read-only
dateBirthFormatted
string | null
read-only
customFieldValues
string<iri-reference>[]
Example:
townCurrent
object | null
phoneNumber
string | null
cardId
string | null
professionHeadline
string | null
feeTenantProductPrice
object | null
postalCode
string | null
address
string | null
professionOrganisation
string | null
professionOrganisationWebsite
string | null
professionOrganisationRole
string | null
companyIdentifier
string | null
companyName
string | null
companyAddress
string | null
companyRegNo
string | null
localCenterParentName
string | null
read-only
isExpiredValidLocalFeeDate
boolean
read-only
isLocalFeeActive
boolean
read-only