Skip to main content
GET
Get All Users ( SUNSETTING )

Authorizations

Authorization
string
header
required

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

Query Parameters

role
string

Filter users by role

start_date
string<date>

Filter users created after this date (YYYY-MM-DD)

end_date
string<date>

Filter users created before this date (YYYY-MM-DD)

sort_order
enum<string>

Sort order (asc or desc)

Available options:
asc,
desc
page
integer

Page number for pagination

per_page
integer

Number of users per page

Response

Users retrieved successfully

data
(Business Response · object | Person Response · object)[]

Schema for a Business response

pagination
object