Payabli Docs

{
  "success": true,
  "message": "People retrieved successfully",
  "traceId": "0HNNQ4R2OT25J:0000005A",
  "data": {
    "data": [
      {
        "_links": {
          "self": "/v2/people/01a0014d-ce1a-7110-9bac-c4c59647a88d"
        },
        "personReference": "01a0014d-ce1a-7110-9bac-c4c59647a88d",
        "firstName": "Marcus",
        "lastName": "Delgado",
        "verificationStatus": "notstarted",
        "createdAt": "2026-08-14T17:24:31.387724",
        "lastUpdated": "2026-08-14T17:24:31.387724",
        "email": "marcus.delgado@example.com"
      }
    ],
    "pagination": {
      "page": 1,
      "totalPages": 1587,
      "totalRecords": 1587,
      "pageSize": 1,
      "hasNext": true,
      "hasPrevious": false
    }
  }
}

Lists people with optional filtering and pagination.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

namestringOptional

Filter by name (partial match).

emailstringOptional

Filter by email (partial match).

verificationStatusstringOptional

Comma-separated verification status filter.

limitintegerOptional

Number of results per page.

pageintegerOptional

Page number to return.

sortBystringOptional

Field to sort by.

sortOrderstringOptional

Sort direction.

Response

A page of people.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The page of people.

Errors

401

Unauthorized Error

500

Internal Server Error