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

POSThttps://app.apollopayment.io/partner/api/get-users

Header parameters

Body

application/json

limitinteger

Number of elements per page

offsetinteger

Number of items to skip

Response

200

Body

application/json

success*boolean

Request success indicator

response*GetPartnerUsersResponse (object)

Date of the user's last login via the web interface

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/partner/api/get-users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "users": [
      {
        "id": "22c0e65e-4640-4b5b-9a28-518c88a421e4",
        "email": "[e-mail]",
        "password": "sCPJUXnBrJ",
        "utm": null,
        "createdAt": "2024-11-07T12:42:22.490Z",
        "updatedAt": "2024-11-07T12:42:22.491Z",
        "confirmedAt": "2024-11-07T13:42:22.491Z",
        "lastLoginAt": null
      }
    ]
  }
}