List all Accounts

Retrieves all Accounts.

HTTP Request

GET https://api.vindicia.com/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
created_before	none	Used to limit results to Accounts created before a specified datetime.	No
created_after	none	Used to limit results to Accounts created after a specified datetime.	No
email	none	The email address of the account - if specified, all Accounts with that email address value will be returned.	No
payment_method	none	This method will return a list of accounts that have the specified Payment Method id or vid associated with them.	No
payment_method.boleto.fiscal_number	none	Limit list to accounts with the Boleto payment method and specified Boleto fiscal number.	No
payment_method.carrier_billing.encoded_phone_number	none	Limit list to accounts with the Carrier Billing payment method and specified Carrier Billing encoded phone number.	No
payment_method.carrier_billing.phone_number	none	Limit list to accounts with the Carrier Billing payment method and specified Carrier Billing billing phone number.	No
payment_method.credit_card.account	none	Limit list to accounts with the Credit Card payment method and specified account number.	No
payment_method.direct_debit.account	none	Limit list to accounts with the Direct Debit payment method and specified account number.	No
payment_method.direct_debit.bank_sort_code	none	Limit list to accounts with the Direct Debit payment method and specified bank sort code.	No
payment_method.ecp.account	none	Limit list to accounts with the ACH (aka ECP) payment method and specified account number.	No
payment_method.ecp.routing_number	none	Limit list to accounts with the ACH (aka ECP) payment method and specified routing number.	No
payment_method.merchant_accepted_payment.last_digits	none	Limit list to accounts with the Merchant Accepted Payment (Pay By Invoice) payment method and specified last digits.	No
payment_method.merchant_accepted_payment.payment_id	none	Limit list to accounts with the Merchant Accepted Payment (Pay By Invoice) payment method and specified payment id.	No
payment_method.paypal.paypal_email	none	Limit list to accounts with the PayPal payment method and specified email address.	No

Accepts

None.

Returns

JSON - A list array with a data property that contains an array of up to limit number of 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

Example Request

curl -X GET \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
"https://api.staging.us-west.vindicia.com/accounts?limit=1&ending_before=cust_1235"

Parent topic:Accounts

Home

Guides

APIs

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

Example Request

​HTTP Request

​Route (URL) Parameters

​Query Parameters

​Accepts

​Returns

​Example Request

HTTP Request

Route (URL) Parameters

Query Parameters

Accepts

Returns

Example Request