Skip to main content

Read users in bulk mode

POST 
/user-ext-srv/bulkread/users

This API reads users in bulk mode using graph filters to select users and limit retrieved fields. This flexible approach allows precise user export. Be aware that this is recommended only for exports and reports.

The pit provides a consistent view of data state when initiated, preventing inconsistencies from changes between searchAfter requests.

Usage without pit:

  1. Use bulk mode with searchAfter by including sortfield (e.g., updatedTime, createdTime)
  2. When sortfield is sent, a sort field returns for each user (e.g., sort: [1622987455])
  3. For the next batch, pass the last user's sort value as searchAfter (e.g., searchAfter: [1622987455])
  4. Continue these steps until response returns status 204, then all users are loaded

Usage with pit:

  1. Use bulk mode with pit by including sortfield and keepAlive: 
    \{
       "sortfield": "updatedTime",
       "pit": \{
          "keepAlive": "3"
       \}
    \}


  2. in case the keepAlive is sent in the request body a field pitId will be returned in response body 
    \{
       "users": [...],
       "pitId": "gcSHBAM2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcAFklsVWc1Y2FpUW1HYjVDQUowVTRYWEEAAAAAAAAoiK4WaVV2R2VGU1NUYmkzTmtjbncxUEVCUQA2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcBFnRhTDBzSldpVHV5TlJ5X3FpUGhzQWcAAAAAAAAfDesWNmVjNXcyM3BRaHUwYjd5azZoNU8xdwA2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcCFmdKZWhVQ2RhU1pXQk44T1M2QllnNWcAAAAAAAAqOKMWaGNMSUxGcC1TNzItaTVYUm5FUF9ndwABFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcAAA=="
    \}
  3. search for the next batch the sort value of the last user entry has to be overhanded as searchAfter (e.g. searchAfter: [1622987455]) and the pitId as id inside the pit object 
    \{
        "sortfield": "updatedTime",
        "pit": \{
           "keepAlive": "3",
           "_id": "gcSHBAM2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcAFklsVWc1Y2FpUW1HYjVDQUowVTRYWEEAAAAAAAAoiK4WaVV2R2VGU1NUYmkzTmtjbncxUEVCUQA2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcBFnRhTDBzSldpVHV5TlJ5X3FpUGhzQWcAAAAAAAAfDesWNmVjNXcyM3BRaHUwYjd5azZoNU8xdwA2Y2lkYWFzLWt1YmUtbmlnaHRseWJ1aWxkLWRldl91c2VyLXNlYXJjaC12aWV3LWluZGV4X3YyFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcCFmdKZWhVQ2RhU1pXQk44T1M2QllnNWcAAAAAAAAqOKMWaGNMSUxGcC1TNzItaTVYUm5FUF9ndwABFmcxMGtrMzJtU3JxWUxMMFhGdFNPRWcAAA=="
        \},
        "searchAfter": [
           1629375844777,
           8589940405
        ]
    \}
  4. this steps can be continued till the response is returning status 204 than all users are loaded

Request​

Responses​

OK