List patrons

GET 
/patrons

List patrons

Request

Query Parameters

currencystring
Example: usd
pageinteger
Example: 1
perPageinteger
Example: 1
querystring
Example: alice
sortstring
Example: -totalAmount

200

Returns the owner's patrons

dataobject[]required

objectstring

idstring

emailstring

firstNamestring

lastNamestring

totalAmountnumber<float>

currencystring

orderCountinteger

createdAtstring

updatedAtstring

memberSincenullable

objectstringrequired

pageintegerrequired

totalPagesintegerrequired

perPageintegerrequired

totalCountintegerrequired

hasNextPagebooleanrequired

Example: returns_the_owner's_patrons

{
  "data": [
    {
      "object": "patron",
      "id": "89537f39-8618-4c03-97c7-7a17bbb4009b",
      "email": "alice@example.com",
      "firstName": "Alice",
      "lastName": "Patron",
      "totalAmount": 100,
      "currency": "usd",
      "orderCount": 1,
      "createdAt": "2026-03-24T16:09:54Z",
      "updatedAt": "2026-03-24T16:09:54Z",
      "memberSince": null
    },
    {
      "object": "patron",
      "id": "7efb3bd2-fc0d-4edf-ac24-3cb24cad71d9",
      "email": "bob@example.com",
      "firstName": "Bob",
      "lastName": "Customer",
      "totalAmount": 50,
      "currency": "usd",
      "orderCount": 1,
      "createdAt": "2026-03-24T16:09:54Z",
      "updatedAt": "2026-03-24T16:09:54Z",
      "memberSince": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 2,
  "hasNextPage": false
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required"
}