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 The ID of the user. SiteId int32 — OPTIONAL The ID of the site associated with the user. Email string — OPTIONAL The email address of the user. FirstName string — OPTIONAL The first name of the user. LastName string — OPTIONAL The last name of the user. PhoneNr string — OPTIONAL The phone number of the user. MobilePhoneNr string — OPTIONAL The mobile phone number of the user. Company string — OPTIONAL The company the user is associated with. Address string — OPTIONAL The address of the user. Address2 string — OPTIONAL The second line of the user's address. Address3 string — OPTIONAL The third line of the user's address. DoorCode string — OPTIONAL The door code for the user's address. PersonalId string — OPTIONAL The personal ID of the user. Birthyear string — OPTIONAL The birth year of the user. Zip string — OPTIONAL The zip code of the user's address. City string — OPTIONAL The city of the user's address. CareOf string — OPTIONAL The care of (c/o) address of the user. Country string — OPTIONAL The country of the user's address. State string — OPTIONAL The state of the user's address. CustomerGroupId int32 — OPTIONAL The id of the customer group that the customer belongs to. CustomerGroupName string — OPTIONAL The name of the customer group that the customer belongs to. MemberId int32 — OPTIONAL The member ID of the user. Obsolete. Use CustomerGroupId instead. MemberType string — OPTIONAL The member type of the user. Obsolete. Use CustomerGroupName instead. CountryId int32 — OPTIONAL The country ID of the user's address. UserTypeId int32 — OPTIONAL UserTypeId of the user. 1 = Private, 2 = Company. GenderType int32 — OPTIONAL Possible values: [0, 1, 2] The gender of the user. Enum type with the following values: Unspecified=0, Female=1, Male=2. 0 = Unspecified 1 = Female 2 = Male MemberDiscount int32 — OPTIONAL The member discount of the user. Newsletter boolean — OPTIONAL Decides whether the user should be subscribed to the newsletter. Blacklisted boolean — OPTIONAL Indicates whether the user is blacklisted. Active boolean — OPTIONAL Indicates whether the user is active. CreatedOn date-time — OPTIONAL The date and time when the user was created. UpdatedOn date-time — OPTIONAL The date and time when the user was last updated. MetaData string — OPTIONAL Metadata associated with the user. BlacklistedOn date-time — OPTIONAL The date and time when the user was blacklisted. BlacklistReason string — OPTIONAL The reason for blacklisting the user. 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.