Skip to main content
Version: Latest (3.102.6)

Read users in bulk mode

POST 
/user-ext-srv/bulkread/users

The Bulk Read API allows you to retrieve large volumes of user data efficiently. It supports advanced filtering, pagination via searchAfter, and consistent data snapshots using Point-In-Time (pit) queries.

Key Concepts​

  • Pagination with searchAfter: To handle large datasets, this API uses a cursor-based pagination mechanism. It requires a sortfield to be specified, and each user in the response will include a sort array. To fetch the next page, provide the sort value of the last user from the current response as the searchAfter value in the next request.
  • Point-In-Time (PIT): Enabling a PIT session creates a consistent snapshot of the data. This ensures that all pagination requests see the exact same data state as it was when the session was initiated, preventing inconsistencies from data changes during export.

Usage without Point-In-Time (PIT)​

  1. Initial Request: Send a POST request including a sortfield (e.g., updatedTime).
  2. Process Response: Each user in the users array will contain a sort field.
  3. Next Page: Extract the sort value of the last user in the response. Pass this value as searchAfter in your next request.
  4. Completion: Repeat until the API returns an HTTP 204 No Content status.

Usage with Point-In-Time (PIT)​

  1. Initial Request: Include sortfield and a pit object with a keepAlive duration (in minutes). 
    \{
       "sortfield": "updatedTime",
       "pit": \{
          "keepAlive": "5"
       \}
    \}
  2. Extract PIT ID: The response will include a pitId. 
    \{
       "users": [...],
       "pitId": "gcSHBAM2Y2lkYWFz..."
    \}
  3. Subsequent Requests: Provide the last user's sort value as searchAfter and the pitId as id inside the pit object. 
    \{
        "sortfield": "updatedTime",
        "pit": \{
           "keepAlive": "5",
           "id": "gcSHBAM2Y2lkYWFz..."
        \},
        "searchAfter": [1629375844777, 8589940405]
    \}
  4. Completion: Continue the loop until the API returns an HTTP 204 No Content status.

Request​

Responses​

OK