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 — REQUIREDThe page to fetch. Omitting the page number will return the first page. |
Request Body — REQUIRED The details of the query. |
---|
CreatedBefore date-timeLimits query to users created before the specified date. |
CreatedAfter date-timeLimits query to users created after the specified date. |
UpdatedAfter date-timeLimits query to users updated after the specified date. |
IncludeInactive booleanSet to true to include inactive users in the query. |
BatchId uuidUsed 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.
| |||||||||||||||||||||||||||||||||||||||||||
400 Bad request.
|