Skip to main content
GET
/
api
/
v3
/
people
Get All People ( STABLE )
curl --request GET \
  --url https://api.grailpay.com/api/v3/people \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "",
  "data": {
    "people": [
      {
        "person": {
          "client_reference_id": "reference_12345",
          "status": "APPROVED",
          "uuid": "7c41f6a2-a4b9-4df8-9225-2c1b7312042e",
          "payout_type": "batch",
          "first_name": "John",
          "last_name": "Dew",
          "email": "john.doe@example.com",
          "phone": "2457856490",
          "address": {
            "line_1": "10554 W Quarles Ave",
            "line_2": "Suite 123",
            "city": "Littleton",
            "state": "CO",
            "zip": "80127"
          },
          "timestamps": {
            "created_at": "2024-06-25 13:57:03"
          }
        },
        "bank_accounts": [
          {
            "aggregator_type": "manual",
            "uuid": "9b97f121-a449-4b52-9f36-6c55f18394d6",
            "is_default": true,
            "account_number": "********1234",
            "routing_number": "*****6789",
            "account_name": "John Doe",
            "account_type": "checking",
            "timestamps": {
              "created_at": "2024-06-25 13:57:03"
            }
          }
        ],
        "relations": {
          "merchant": {
            "uuid": "c6bcfbbb-98ff-4d8b-a8f5-1559c3dcb718"
          }
        }
      }
    ]
  },
  "errors": null,
  "request_id": "2d6a4c39-8fcf-4d80-9189-b4764eac31f2",
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 25,
    "links": [
      {}
    ],
    "per_page": 15,
    "to": 15,
    "total": 370
  }
}

Authorizations

​
Authorization
string
header
required

Token-based authentication using Authorization: Bearer <YOUR_API_KEY> provided by the GrailPay Support Team.

Query Parameters

​
filter[uuid]
string<uuid>

Filter by person UUID

Example:

"7c41f6a2-a4b9-4df8-9225-2c1b7312042e"

​
filter[client_reference_id]
string

Filter by client reference ID

Example:

"reference_12345"

​
filter[first_name]
string

Filter by first name

Example:

"John"

​
filter[last_name]
string

Filter by last name

Example:

"Doe"

​
sort
string

Sort by field (created_at, first_name, last_name). Prefix with '-' for descending order

Example:

"-created_at"

​
page
integer

Page number for pagination

Example:

1

​
per_page
integer
default:15

Number of records per page

Example:

15

Response

The response returned from a successful call to listing people.

​
status
boolean
Example:

true

​
message
string
Example:

""

​
data
object
​
errors
object | null
Example:

null

​
request_id
string<uuid>
Example:

"2d6a4c39-8fcf-4d80-9189-b4764eac31f2"

​
meta
object