HomeAPI Reference
API Reference
Start typing to search…

List Consumers

get
https://api.zype.com/consumers
Query Params
string

Filter by ID Example: id=5992f328ce593000ef000008

string

Filter records by created date using times in ISO8601 format (Example: 2017-01-01T00:00:00-00:00) or Unix timestamps (Example: 1483228800) Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: created_at.gte)

string

Filter records by updated at date using times in ISO8601 format (Example: 2017-01-01T00:00:00-00:00) or Unix timestamps (Example: 1483228800) Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: updated_at.gte)

string

Filter by keyword

string
enum

Filter by ascending or descending order

Allowed:
string

Sort on the specified field

integer

Page number to return, with per_page dictating page size

integer

Number of records to return per page

string

Filter by the consumer's Braintree ID

string

Filter by the consumer's Recurly Code

string

Filter by the consumer's Stripe ID

string

Filter by the consumer's email

string

Filter by the consumer's password token

string

Filter by the consumer's RSS token

integer

Filter consumers by the number of pass plans that have been purchased or redeemed. Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: pass_count.gte = 1)

integer

Filter consumers by the number of playlists they are entitled to watch via purchase or pass plan. Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: playlist_count.gte = 1)

string

The password token to use during remember login workflows

integer

Filter consumers by the number of times they have signed in. Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: sign_in_count.gte)

string

Filter records by last_sign_in_at using times in ISO8601 format (Example: 2017-01-01T00:00:00-00:00) or Unix timestamps (Example: 1483228800) Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: last_sign_in_at.gte)

string

Filter records by current_sign_in_at using times in ISO8601 format (Example: 2017-01-01T00:00:00-00:00) or Unix timestamps (Example: 1483228800) Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: current_sign_in_at.gte)

boolean

Boolean field to indicate if the consumer has agreed to terms and conditions

boolean

Boolean field to indicate if the consumer has agreed to receive updates

integer

Filter records by video count Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: video_count.gte = 3)

integer

Filter consumers by their number of transactions. Note: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: transaction.gte = 3)

string
enum

Filter records by payment provider.

string

Filter records by custom attribues + Example: custom[weight]=100

Responses

Updated 7 months ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago