List users

Retrieves a list of users

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

created_at.after

string

Return users created after this ISO 8601 timestamp.

created_at.before

string

Return users created before this ISO 8601 timestamp.

cursor

string

The cursor for the next page of results to fetch

Example:

"vjl8vk3l4o8dhsjlzh=="

status

enum<string>[]

Filter users by status. Provide multiple values to retrieve users with any of the provided statuses.

Available options:

created,

enabled,

suspended,

disabled

Response

200

application/json

successful operation

data

object[]

required

Show child attributes

data.id

string

required

Push's identifier assigned to the user

data.tag

string | null

required

The tag provided in the request to create the user

data.status

enum<string>

required

Available options:

created,

enabled,

suspended,

disabled

data.name

object

required

The legal name of the user

Show child attributes

data.name.first

string

required

The person's given name

data.name.last

string

required

The person's family name

Example:

{ "first": "Alfred", "last": "Hitchcock" }

data.address

object

required

The address of the user's primary location

Show child attributes

data.address.address_line_1

string

required

The first line for the address

data.address.locality

string

required

The city or township

data.address.administrative_area

string

required

The state as a two-character code (e.g., CA, WA, TN, AL).

data.address.postal_code

string

required

The postal code, following the format XXXXX or XXXXX-XXXX.

data.address.country

string

required

The country

Example:

{
  "address_line_1": "1609 10th Ave",
  "locality": "Bodega Bay",
  "administrative_area": "CA",
  "postal_code": "94923",
  "country": "US"
}

data.email

string

required

The email address for the user

Example:

"[e-mail]"

data.phone_number

string | null

required

The phone number for the user

Example:

"15559283950"

data.date_of_birth

string

required

The user's date of birth

data.government_id

object

required

Show child attributes

data.government_id.type

enum<string>

required

The type of government-issued ID

Available options:

drivers_license,

passport,

state_id,

military_id,

ssn

data.government_id.last4

string

required

The last 4 characters of the ID or number

data.government_id.state

string

The 2-letter code for the state in which the ID was issued. Only required if the ID is a driver's license or state ID.

Required string length: 2

Example:

{
  "type": "drivers_license",
  "last4": "Y7B9",
  "state": "OR"
}

data.payment_credentials

array | null

required

The payment credentials associated with the user

The details for the user's payment credential

Show child attributes

data.payment_credentials.bank_name

string

required

The name of the bank associated with the credential

Example:

"Space Coast Credit Union"

data.payment_credentials.account

object

required

Show child attributes

data.payment_credentials.account.number_mask

string

required

The account number (mask)

data.payment_credentials.account.routing

string

required

The routing number for the account

data.payment_credentials.card

object

required

Show child attributes

data.payment_credentials.card.primary_account_number_mask

string

required

The primary account number (mask)

data.payment_credentials.card.expiration

string

required

The expiration date for the card

data.limits

object

required

The transaction limits for the user

Show child attributes

data.limits.daily_limit

integer

required

The daily transaction limit for the user (in the smallest currency unit).

data.limits.currency

enum<string>

required

Currency associated with the amount

Available options:

USD

data.created_at

string

required

Date and time in which user was first created in system

next_cursor

string | null

required

Use cursor for paginating list endpoints in conjunction with the cursor request parameter.

In a response, the value is null if there are no more results to fetch.

Example:

"vjl8vk3l4o8dhsjlzh=="