Skip to content
/accounts

List user accounts

Request

Security
oauth2ClientCredentials(Required scopes: accounts:read)
Query
pagenumber

Page number (minimum: 1)

Example:page=1
limitnumber

Number of items per page (minimum: 1, maximum: 1000)

Example:limit=20
Headers
org_wallet_refstring

Organization wallet reference, defaults to "1" if not provided

business_idstringrequired

Business identifier for the request

curl -i -X GET \
  'https://developer.boyahq.com/_mock/v2/openapi/accounts?page=1&limit=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string'

Responses

Paginated list of user accounts

Bodyapplication/json
statusnumberrequired

HTTP status code

Example:200
dataobject(PaginatedDataDto)required

Response data

messagestring

Optional response message

Example:"Operation completed successfully"
timestampstringrequired

Response timestamp in ISO format

Example:"2024-01-01T00:00:00.000Z"
pathstring

Request path (mainly for error responses)

Example:"/api/v1/accounts"
Response
{
  "status": 200,
  "data": {
    "total": 100,
    "pages": 10,
    "page": 1,
    "limit": 10,
    "docs": []
  },
  "message": "Operation completed successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "path": "/api/v1/accounts"
}