Skip to main content
GET
/
api
/
v1
/
users-role-group-csv
Error
A valid request URL is required to generate request examples
[
  {
    "user": {
      "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

​
unit
string
​
unit[]
string[]
​
user.type
string
​
user.type[]
string[]
​
user.status
string
​
user.status[]
string[]
​
user.townCurrent
string
​
user.townCurrent[]
string[]
​
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

Response

UserUnitRoleGroup collection

​
user
object