Skip to main content

​
List Bulk Import Users

curl -X GET "https://your-domain.com/bulk-import/users?status=FAILED&limit=100&paginationToken=token" \
  -H "Content-Type: application/json"

{
  "status": "OK",
  "users": [
    {
      "id": "bulk-import-user-id",
      "status": "FAILED",
      "externalUserId": "user-123",
      "userMetadata": {"plan": "premium"},
      "errorMessage": "Email already exists",
      "createdAt": 1234567890000,
      "updatedAt": 1234567895000
    }
  ],
  "nextPaginationToken": "next-token"
}
​
status
string
Filter by status: “NEW”, “PROCESSING”, or “FAILED”
​
limit
number
Number of users to return (default: 500, max: 1000)
​
paginationToken
string
Token for fetching next page of results
​
status
string
“OK”
​
users
array
Array of bulk import user objects matching the filter
​
users[].id
string
Bulk import user ID
​
users[].status
string
Current status: “NEW”, “PROCESSING”, or “FAILED”
​
users[].externalUserId
string
External user identifier
​
users[].errorMessage
string
Error message if status is “FAILED”
​
users[].createdAt
number
Timestamp when import was created (milliseconds since epoch)
​
users[].updatedAt
number
Timestamp when import was last updated (milliseconds since epoch)
​
nextPaginationToken
string
Token for fetching the next page (omitted if no more results)

​
Count Bulk Import Users

curl -X GET "https://your-domain.com/bulk-import/users/count?status=FAILED" \
  -H "Content-Type: application/json"

{
  "status": "OK",
  "count": 42
}
​
status
string
Filter by status: “NEW”, “PROCESSING”, or “FAILED”. If omitted, returns count of all users
​
status
string
“OK”
​
count
number
Total number of bulk import users matching the filter

Build docs developers (and LLMs) love

Get started for freeTalk to us