JAjammed-org
Customer

Find all customers

Changed on

Returns all customers, newest first.

Pass email to look one customer up by their exact email address (ignoring case and surrounding spaces). Deleted customers never match an email lookup.

get/customers.json

Request

  • Base URL
    https://api.jammed.app/api/v2
  • Auth
    none declared. Required headers: Authorization

Query parameters

emailstring

Only the non-deleted customer with this exact email address

pageinteger
per_pageinteger

Headers

Authorizationstring required

Response

successful operation

idinteger

Use to identify the customer in other API calls

namestring

The customers given full name

emailstring

The customers email address

mobilestring

The customers mobile phone number

avatarstring

The customers avatar image URL, if any

credit_balanceinteger

The customers current credit balance in cents/pence/units

This cannot be changed via the API

status'unregistered' | 'invited' | 'registered' | 'banned' | 'behind_payment'

The status of the customer

unregistered: The customer has booked but not registered an account invited: The customer has been invited to register an account registered: The customer has registered an account banned: The customer has been marked as banned from booking (and will not be able to book) behind_payment: The customer has been marked as behind on payments (and will not be able to book)

reminders_opt_inboolean

Whether this customer wants to receive reminders

mailing_list_opt_inboolean

Whether this customer wants to be on the mailing list

signed_upboolean

Whether the customer has signed up

signed_up_atinteger

Unix timestamp from epoch - when the customer signed up

bookings_countinteger

The number of bookings the customer has made

created_atinteger

Unix timestamp from epoch - when the customer was created

updated_atinteger

Unix timestamp from epoch - when the customer was last updated

last_booking_atinteger

Unix timestamp from epoch - when the customer last booked

Changes

  • v2d512cbbe42fbRevision changes
    • info

      api tag Customer added

    • info

      api tag Customer Endpoints removed

  • v2c3207a6b3fedRevision changes
    • info

      added the new optional query request parameter email

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter per_page