Skip to main content
GET
/
api
/
v1
/
users-csv
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "status": "<string>",
    "gender": "<string>",
    "localCenter": {
      "name": "<string>"
    },
    "localCenterParent": "https://example.com/",
    "type": {
      "name": "<string>"
    },
    "age": 123,
    "isFeeActive": true,
    "isExpiredValidFeeDate": true,
    "dateJoinedFullMemberFormatted": "<string>",
    "dateBirthFormatted": "<string>",
    "townCurrent": {
      "name": "<string>"
    },
    "phoneNumber": "<string>",
    "cardId": "<string>",
    "professionHeadline": "<string>",
    "feeTenantProductPrice": {
      "name": "<string>",
      "isLifetime": true
    },
    "postalCode": "<string>",
    "address": "<string>",
    "professionOrganisation": "<string>",
    "professionOrganisationRole": "<string>",
    "companyIdentifier": "<string>",
    "companyName": "<string>",
    "companyAddress": "<string>",
    "companyRegNo": "<string>",
    "isExpiredValidLocalFeeDate": true,
    "isLocalFeeActive": true
  }
]

Query Parameters

​
page
integer
default:1

The collection page number

​
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
​
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
​
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
​
exists[professionIndustry]
boolean
​
exists[professionHeadline]
boolean
​
exists[isFullMember]
boolean
​
exists[userRoles.dateEnded]
boolean

Response

User collection

​
id
integer
​
firstName
string | null
​
lastName
string | null
​
email
string<email> | null
​
status
string
​
gender
string | null
​
localCenter
object
​
localCenterParent
string<iri-reference> | null
Example:

"https://example.com/"

​
type
object
​
age
integer | null
​
isFeeActive
boolean
​
isExpiredValidFeeDate
boolean
​
dateJoinedFullMemberFormatted
string | null
​
dateBirthFormatted
string | null
​
townCurrent
object
​
phoneNumber
string | null
​
cardId
string | null
​
professionHeadline
string | null
​
feeTenantProductPrice
object
​
postalCode
string | null
​
address
string | null
​
professionOrganisation
string | null
​
professionOrganisationRole
string | null
​
companyIdentifier
string | null
​
companyName
string | null
​
companyAddress
string | null
​
companyRegNo
string | null
​
isExpiredValidLocalFeeDate
boolean
​
isLocalFeeActive
boolean