Bank Accounts

List Bank Accounts

Changed on

Get a list of bank accounts.

Note that we do not return the complete account number or the signature image for security reasons.

get/print-mail/v1/bank_accounts

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/bank_accounts
  • Auth
    API key in header X-API-Key

Query parameters

skipinteger
limitinteger
string
OR
string

You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource.

For example, let's say you created a series of letters that all had metadata: { campaignID: 'abc' }. You could search for all those letters by passing in { "metadata.campaignID": "abc" } into the search parameter.

Note that this string must be valid JSON.

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

Response

The request has succeeded.

object'list' required
totalCountinteger required
skipinteger required
limitinteger required

Changes

  • c8fedcbd705eRevision changes
    • warning

      added the new internal_server_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded_error enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status