Skip to main content
GET
/
user
/
list
List users
curl --request GET \
  --url https://api.pushcash.com/user/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "user_28CJjV7P4Go5PNJvfzghiD",
      "tag": "4c8e6b4f",
      "status": "enabled",
      "name": {
        "first": "Alfred",
        "last": "Hitchcock"
      },
      "address": {
        "address_line_1": "1609 10th Ave",
        "locality": "Bodega Bay",
        "administrative_area": "CA",
        "postal_code": "94923",
        "country": "US"
      },
      "email": "[email protected]",
      "phone_number": "(555) 681-3485",
      "date_of_birth": "1899-08-13",
      "government_id": {
        "type": "passport",
        "last4": "7349"
      },
      "payment_credentials": [
        {
          "bank_name": "Space Coast Credit Union",
          "account": {
            "number_mask": "5978",
            "routing": "263177903"
          },
          "card": {
            "primary_account_number_mask": "6018",
            "expiration": "2024-05-01"
          }
        }
      ],
      "limits": {
        "daily_limit": 1800000,
        "currency": "USD"
      },
      "created_at": "2023-04-10T05:10:14.532Z"
    }
  ],
  "next_cursor": "vjl8vk3l4o8dhsjlzh=="
}

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<date-time>

Return users created after this ISO 8601 timestamp.

​
created_at.before
string<date-time>

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

successful operation

​
data
object[]
required
​
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=="