Counterparty

List all counterparties

Retrieve all counterparties under your developer account. Filtered results can be retrieved with extra parameters in the query (account_number, routing_number, etc.).

get/counterparties

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/counterparties
  • Auth: HTTP basic

Query parameters

account_numberstring

Filter counterparties by account number.

created.gtstring date-time

Return results where the created_at field is greater than this value.

created.gtestring date-time

Return results where the created_at field is greater than or equal to this value.

created.ltstring date-time

Return results where the created_at field is less than this value.

created.ltestring date-time

Return results where the created_at field is less than or equal to this value.

deduplicateboolean

When true, collapses duplicate counterparties (same account/routing) into a single result.

descriptionstring

Filter counterparties by description (substring match).

ending_beforestring

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo, your subsequent call can include ending_before=foo_ZXhhbXBsZQo in order to fetch the previous page of the list.

limitinteger

A limit on the number of objects to be returned, between 1 and 100. The default is 10.

querystring

Free-form search query that matches against counterparty fields.

routing_numberstring

Filter counterparties by routing number.

sortstring

Field to sort results by.

sort_orderstring

Sort direction. Can be asc or desc.

starting_afterstring

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.

Response

Successful response

has_moreboolean required

Whether there are more results available after this set.

Changes

No recorded changes to this operation across all 1 revision of this API.