Skip to main content
Vindicia Knowledge Center

List all Accounts

List all Accounts

Retrieves all Accounts.

Route (URL) Parameters

None.

Query Parameters

Parameter Default Description Required
limit 20 A limit on the number of objects to be returned, between 1 and 100. No
starting_after none A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. No
ending_before none A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. No
email none The email address of the account - if specified, all Accounts with that email address value will be returned. No

Accepts

None.

Returns

JSON A list array with a data property that contains an array of up to limit Accounts, starting after the specified starting_after Account (or ending before the specified ending_before Account).. Each entry in the array is a full Account object. If no more Accounts are available, the resulting array will be empty. This request should never throw an error.

A list of Account objects matching the query. Also:

  • “total_count”: Integer count of the number of Accounts in the returned list.
  • “url”: The query string provided in the request
  • “next”: The route (partial URL) to the next Account object (string to select the “next”); included id should match that of the last object returned here
  • “previous”: The route (partial URL) to the previous Account object (string to select the “previous”); included id should match that of the first object returned here
  • cURL
  • Java
Example Request
curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.prodtest.vindicia.com/accounts?limit=1&ending_before=cust_1235"
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
        "object": "Account",
        "id": "cust_1234",
        "vid": "f147870b2c86a00fb1264fb64c0a8b58fcd95b4d",
        "created": "2016-05-18T13:39:03-07:00",
        "default_currency": "USD",
        "email": "cbrown@example.com",
        "email_type": "html",
        "language": "EN-U",
        "notify_before_billing": true,
        "company": "Peanuts",
        "name": "Charlie Brown",
        "shipping_address": {
            "object": "Address",
            "vid": "dad524f59d1bd72f10a9162b7d7790caa39678dc",
            "name": "Charlie Brown",
            "line1": "123 Main Street",
            "city": "San Francisco",
            "district": "CA",
            "postal_code": "94105",
            "country": "US",
            "phone": "415-555-3212"
        },
        "metadata": {
            "favorite dog": "Snoopy",
            "favorite activity": "flying kites"
        }
        }
    ],
    "total_count": 1,
    "url": "/accounts?limit=1",
    "next": "/accounts?limit=1&starting_after=cust_1234",
    "previous": "/accounts?limit=1&ending_before=cust_1234"
}
import com.vindicia.client.CashBox;
CashBox.apiKey = "acaff38d462f9430d5cbcbafa575771fc679b9de";
Map<string,> params = new HashMap<string,>();
params.put("limit",  1);
Account.list(params);
The above command returns JSON structured like this:
{
    "object": "List",
    "data": [
        {
        "object": "Account",
        "id": "cust_1234",
        "vid": "f147870b2c86a00fb1264fb64c0a8b58fcd95b4d",
        "created": "2016-05-18T13:39:03-07:00",
        "default_currency": "USD",
        "email": "cbrown@example.com",
        "email_type": "html",
        "language": "EN-U",
        "notify_before_billing": true,
        "company": "Peanuts",
        "name": "Charlie Brown",
        "shipping_address": {
            "object": "Address",
            "vid": "dad524f59d1bd72f10a9162b7d7790caa39678dc",
            "name": "Charlie Brown",
            "line1": "123 Main Street",
            "city": "San Francisco",
            "district": "CA",
            "postal_code": "94105",
            "country": "US",
            "phone": "415-555-3212"
        },
        "metadata": {
            "favorite dog": "Snoopy",
            "favorite activity": "flying kites"
        }
        }
    ],
    "total_count": 1,
    "url": "/accounts?limit=1",
    "next": "/accounts?limit=1&starting_after=cust_1234",
    "previous": "/accounts?limit=1&ending_before=cust_1234"
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top