Skip to main content

Query user profiles

Queries user profiles and stores the result in a batch. Results are fetched from this batch one page at a time via subsequent requests.
BatchId is mandatory when fetching any page other than the first page.
If no BatchId is provided for the first page, a new batch is created and the id for that batch can be found in the response.

Path Parameters
page int32 REQUIRED

The page to fetch. Omitting the page number will return the first page.

Request Body REQUIRED

The details of the query.

CreatedBefore date-time

Limits query to users created before the specified date.

CreatedAfter date-time

Limits query to users created after the specified date.

UpdatedAfter date-time

Limits query to users updated after the specified date.

IncludeInactive boolean

Set to true to include inactive users in the query.

BatchId uuid

Used to fetch products where the result set is split into batches.

UserId int32
Email string
Responses
200

A collection of user profile matching the supplied query and batch page.

Schema OPTIONAL
PageResult object OPTIONAL

Contains pagination information for paged operations, i.e. PageSize and PageCount.

BatchId uuid OPTIONAL

The id of the batch operation. If this property has a value for the first fetched page it has to be passed as a parameter for all subsequent requests.

Page int32 OPTIONAL

The current page

RowCount int32 OPTIONAL

Total number of rows

PageCount int32 OPTIONAL

Total number of pages

PageSize int32 OPTIONAL

Page size

HasMoreRows boolean OPTIONAL

True if there is more content to fetch.

Resource object[] OPTIONAL

The resource on which the action was taken.

UserId int32 OPTIONAL
SiteId int32 OPTIONAL
Email string OPTIONAL
FirstName string OPTIONAL
LastName string OPTIONAL
PhoneNr string OPTIONAL
MobilePhoneNr string OPTIONAL
Company string OPTIONAL
Address string OPTIONAL
Address2 string OPTIONAL
Address3 string OPTIONAL
DoorCode string OPTIONAL
PersonalId string OPTIONAL
Birthyear string OPTIONAL
Zip string OPTIONAL
City string OPTIONAL
CareOf string OPTIONAL
Country string OPTIONAL
MemberId int32 OPTIONAL
MemberType string OPTIONAL
CountryId int32 OPTIONAL
UserTypeId int32 OPTIONAL
Gender boolean OPTIONAL
MemberDiscount int32 OPTIONAL
Newsletter boolean OPTIONAL

Decides whether the user should be subscribed to the newsletter.

Blacklisted boolean OPTIONAL
Active boolean OPTIONAL
CreatedOn date-time OPTIONAL
UpdatedOn date-time OPTIONAL
MetaData string OPTIONAL
BlacklistedOn date-time OPTIONAL
BlacklistReason string OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.