Platform API

List all user IDs

Use List all user IDs to page through identifiers for users registered with OpenIM. This lightweight endpoint is suitable for batch processing and data synchronization; retrieve full profiles separately when needed.

HTTP request

POST {API_ADDRESS}/user/get_all_users_uid

Request example

curl --request POST "${API_ADDRESS}/user/get_all_users_uid" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}'

Keep administrator tokens on trusted backend services only. Client applications should use user tokens issued by your backend.

Request body

{
  "pagination": {
    "pageNumber": 1,
    "showNumber": 100
  }
}

Parameter	Required	Type	Description
pagination	Yes	object	Pagination settings.
pagination.pageNumber	Yes	int	Page number, starting from 1.
pagination.showNumber	Yes	int	Number of records to return per page.

Response

OpenIM usually returns 200 OK when the request reaches the service. Use errCode in the JSON response to determine business success; errCode === 0 means the operation succeeded.

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "data": {
    "total": 2,
    "userIDs": [
      "user_001",
      "user_002"
    ]
  }
}

Response fields

Field	Type	Description
errCode	int	Business error code. `0` means success.
errMsg	string	Short error message.
errDlt	string	Detailed error information for troubleshooting.
data	object	Endpoint-specific response data.
total	int	Total number of matching records.
userIDs	array	List of OpenIM user IDs.

Pagination

Start with pagination.pageNumber = 1. Compare the number of IDs already read with data.total to determine whether another page is required. To retrieve profiles, pass the returned IDs to Get users.

Error response

When a request fails, OpenIM returns the same error envelope. See Error codes for the full handling model.

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Scenario	Possible cause	Recommended action
Authentication failed	`token` is missing, expired, or not an administrator token.	Issue a new administrator token and keep it on the backend.
Traceability is weak	`operationID` is missing or reused across many requests.	Generate a unique `operationID` for every request and log it with the response.
Validation failed	The request body has an invalid type, missing field, or unsupported enum value.	Compare the payload with the request table and retry after correcting the fields.

Permissions and limits

pagination.pageNumber starts at 1.
This endpoint returns IDs only; it does not return UserInfo objects.

Was this page helpful?