Skip to main content
GET
/
api
/
v1
/
customers
cURL
curl --request GET \
  --url https://api-staging.getmeadow.com/api/v1/customers \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>'
{
  "id": 123,
  "hashId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "joinedAt": "<string>",
  "updatedAt": "<string>",
  "birthday": "<string>",
  "sex": "<string>",
  "zip": "<string>",
  "licenseExpiry": "<string>",
  "marketingOptIn": true,
  "marketingOptInAt": "<string>",
  "customerGroups": [
    "<string>"
  ],
  "loyalty": {
    "pointsAmount": 123
  },
  "mostRecentAddress": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "medicalExpiration": "<string>"
}

Authorizations

​
X-Consumer-Key
string
header
required

The key assigned to your company and provided via Meadow

​
X-Client-Key
string
header
required

The key generated and provided by our mutual client

Query Parameters

​
startingAfter
integer<int64>

The id for a customer that you want to retrieve all customers after this one. Pass in the last id in a response to retrieve the next page.

​
startingOn
string

A date that must be formatted as YYYY-MM-DD. When submitted, the response will return the latest customer on that day and continue in reverse chronological order. I.E. if 2022-11-25 is passed in, the first customer will be as close to 11:59pm November 25th, 2022 as possible.

​
sortBy
enum<string>

Accepts a single value of updatedAt if you would like the customers list to be sorted by when each customer was last updated in reverse chronological order (i.e. most recently updated first). Example on how to use: ?sortBy=updatedAt

Available options:
updatedAt

Response

List customers response

​
id
number

The id for the customer

​
hashId
string

An ID used to display to the customer and dispensary instead of the id number

​
firstName
string

The first name of the customer

​
lastName
string

The last name of the customer

​
email
string | null

The email of the customer

​
phone
string | null

The phone of the customer

​
joinedAt
string

The date the customer joined the dispensary

​
updatedAt
string

The date this customer was last updated

​
birthday
string | null

The birthday of the customer in YYYY-MM-DD

​
sex
string | null

One of male, female, tertiary

​
zip
string | null

The postal code of the customer

​
licenseExpiry
string | null

The expiration date of this customer’s drivers license or null if it is not recorded.

​
marketingOptIn
boolean

Whether this customer is opted in to receive marketing

​
marketingOptInAt
string | null

When this customer opted in to marketing or null

​
customerGroups
string[]

An array of Strings for the names of the customer groups this customer is a part of (Example: Veterans, Seniors, etc.)

​
loyalty
object

Information about the loyalty of the customer

​
mostRecentAddress
object

The most recent address used for a delivery order or null if one does not exist

​
medicalExpiration
string | null

The expiration date of this customer’s medical recommendation or null if they are an adult use customer