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
email	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

Get all users

post

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

The body of the request to get a list of users

limitintegerOptional

Number of elements per page

offsetintegerOptional

Number of items to skip

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /partner/api/get-users HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "limit": 1,
  "offset": 1
}

200Success

{
  "success": true,
  "response": {
    "users": [
      {
        "id": "09c89009-2dcb-415e-a0dc-907d407426ac",
        "email": "[e-mail]",
        "password": "sCPJUXnBrJ",
        "utm": null,
        "createdAt": "2025-05-14T13:39:50.396Z",
        "updatedAt": "2025-05-14T13:39:50.397Z",
        "confirmedAt": "2025-05-14T14:39:50.397Z",
        "lastLoginAt": null
      }
    ],
    "total": 1
  }
}