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

metaobjectrequired

requestIdstringrequired

Example: returns_the_owner's_patrons

{
  "data": [
    {
      "object": "patron",
      "id": "e2b80e18-826e-4b74-9d3c-04a335005a89",
      "email": "alice@example.com",
      "firstName": "Alice",
      "lastName": "Patron",
      "totalAmount": 100,
      "currency": "usd",
      "orderCount": 1,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "memberSince": null
    },
    {
      "object": "patron",
      "id": "cecceccd-ce9f-4b08-aa2f-8df7eccb0d70",
      "email": "jane-customer@example.com",
      "firstName": "Jane",
      "lastName": "Customer",
      "totalAmount": 75,
      "currency": "usd",
      "orderCount": 1,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "memberSince": null
    },
    {
      "object": "patron",
      "id": "a2ee0df1-c694-4e64-bd70-3619390d0a15",
      "email": "bob@example.com",
      "firstName": "Bob",
      "lastName": "Customer",
      "totalAmount": 50,
      "currency": "usd",
      "orderCount": 1,
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "memberSince": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 3,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}