Export users

Export users who match the provided parameters.

SecurityZephrHmacHttp
Request
query Parameters
attributes
required
boolean

Whether or not to include core attributes.

Example: attributes=true
appIds
required
string

Comma-delimited list of appIds to retrieve extended profile data for. If appIds is present and attributes isn't, only users with matching extended profiles will be returned.

Example: appIds=quiz1,survey4
appIdsRestrictive
boolean

Only include users with a matching extended profile

Example: appIdsRestrictive=true
grants
boolean

Include information about entitlements

Example: grants=true
since
string

Users who were updated after the specified date

Example: since=2020-01-01T00:00:00Z
registeredSince
string

Users who have registered after the specified date

Example: registeredSince=2020-01-01T00:00:00Z
registeredBefore
string

Users who have registered before the specified date

Example: registeredBefore=2020-01-01T00:00:00Z
rpp
number
Default: 500

Results per page

Example: rpp=40
page
number
Default: 1

The requested page of results

Example: page=1
Responses
200

OK - The paginated user data has been exported successfully.

get/v3/user-export
Response samples
application/json
{
  • "results": [
    ],
  • "meta": {
    },
  • "links": {}
}