POST
/
api
/
platform
/
users
/
list
List Platform Users
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/users/list \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '{
  "rows_per_page": 50,
  "page_no": 1
}'
{
  "success": true,
  "status_code": 123,
  "message": "<string>",
  "records": [
    {
      "user_id": "b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone_country_code": "+1",
      "phone": "1234567890",
      "created_at": "2025-06-10T18:10:42.000Z"
    }
  ],
  "totalRecords": 123,
  "queryGeneratedTime": 123
}

Headers

X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Body

application/json
rows_per_page
enum<integer>
required

Number of records to return per page. Accepted values are 10, 20, 50, or 100.

Available options:
10,
20,
50,
100
page_no
integer
required

Page number to retrieve, starting from 1. For example, page_no=1 returns the first page of results.

Required range: x >= 1
Example:

1

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

status_code
integer | null
default:200

HTTP status code representing the result of the request.

message
string | null
default:Success

Short, human-readable message describing the outcome of the request.

records
PlatformUserRead · object[] | null

List of result items returned for the current page.

totalRecords
integer | null
default:0

Total number of matching records in the database, useful for paginating the full dataset.

queryGeneratedTime
integer | null
default:1756883312

Unix timestamp (in seconds) indicating when this response was generated.