Returns the list of Customer objects

get

https://qa2.revelup.com/resources/Customer/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

updated_date

date-time

Expects an ISO8601 timestamp. It will display Customer objects updated at this exact time. Useful with the "gt" & "lt" additional filters.

phone_number

string

When specified, will only display Customer objects with an exact match of the "phone_number" field. Not limited to numberic values.

last_name

string

When specified, will only display Customer objects with an exact match of the "last_name" field.

total_purchases

integer

Expects a positive integer value. Will only display Customer objects that have the specified amount of purchases attached to their name.

active

boolean

Flag. If set to True, will only display Customer objects that are visible in the system.

first_name

string

When specified, will only display Customer objects with an exact match of the "first_name" field.

uuid

string

When specified, will only display Customer objects with an exact match of the "uuid" field.

ref_number

string

When specified, will only display Customer objects with an exact match of the "ref_number" field. Not limited to numeric values.

string

When specified, will only display Customer objects with an exact match of the "email" field.

created_date

date-time

Expects an ISO8601 timestamp. Will display Customer objects created at this exact time. Useful with the "gt" & "lt" additional filters.

total_visits

integer

Expects a positive integer value. Will only display Customer objects that have the specified amount of visits attached to their name.

fields

array of strings

Comma separated list of fields to display. Only the specified fields will be returned in the response body, along with fields related to those specified.

fields

order_by

string

enum

Allowed:

limit

integer

Limit for results count

offset

integer

Offset for returned results

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

200Resource successfully retrieved.