Get all users
The method allows you to get all users
Request:
Parameter
Required
Type
Description
userId
Yes
String
User ID
limit
Yes
Number
Limit on the number of users in the response
offset
Yes
Number
Offset (for pagination)
Response:
Parameter
Type
Description
users
Array
Array of user objects
total
Number
Total number of users
User object:
Parameter
Type
Description
id
String
User ID
String
User's email
utm
String or null
UTM tag data (if the user has registered via the web interface)
createdAt
String
User registration date
confirmedAt
String or null
Date of confirmation of the user's mail
lastLoginAt
String
Date of the user's last login via the web interface
Public API-key
Signing the request body with a private API-key
Request content type
application/json
The body of the request to get a list of users
Number of elements per page
Number of items to skip
POST /partner/api/get-users HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"limit": 1,
"offset": 1
}
{
"success": true,
"response": {
"users": [
{
"id": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
"email": "[email protected]",
"password": "sCPJUXnBrJ",
"utm": null,
"createdAt": "2025-06-09T13:18:11.462Z",
"updatedAt": "2025-06-09T13:18:11.462Z",
"confirmedAt": "2025-06-09T14:18:11.462Z",
"lastLoginAt": null
}
],
"total": 1
}
}
Last updated