Skip to main content
GET
/
partner
/
users
List users
curl --request GET \
  --url https://m2m-backend-qa.up.railway.app/partner/users \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "items": [
      {
        "userId": "user_acme_x1y2z3",
        "referenceId": "user-12345",
        "name": {
          "firstName": "Juan",
          "secondName": "Carlos",
          "lastName": "Pérez",
          "secondLastName": "García"
        },
        "cipStatus": "verified",
        "blocked": false,
        "createdAt": "2026-02-10T12:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 85,
      "totalPages": 5
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Your partner API key. Use m2m_test_* keys for the sandbox environment.

Query Parameters

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

​
from
string

Filter records created on or after this date (ISO 8601)

Example:

"2026-01-01T00:00:00.000Z"

​
to
string

Filter records created on or before this date (ISO 8601)

Example:

"2026-02-28T23:59:59.999Z"

​
referenceId
string

Filter users by the partner reference ID assigned during link creation

Example:

"user-12345"

​
cipStatus
enum<string>

Filter by CIP verification status. "pending" = verification not started or in progress. "verified" = identity successfully verified. "failed" = verification failed.

Available options:
pending,
verified,
failed
Example:

"verified"

​
blocked
enum<string>

Filter by blocked status. "true" returns only blocked users, "false" returns only unblocked users.

Available options:
true,
false
Example:

"false"

Response

Paginated list of users

​
success
boolean
required
Example:

true

​
data
object
required