Retrieve counterparties

GET {{url}}/api/1.0/counterparties

Request Params

Key	Datatype	Description
`name`	null	The name of the counterparty to retrieve. It does not need to be an exact match, partial match is also supported.
`account_no`	null	The exact account number of the counterparty to retrieve.
`sort_code`	null	The exact sort code of the counterparty to retrieve. Only allowed in combination with the account_no parameter.
`iban`	null	The exact IBAN of the counterparty to retrieve.
`bic`	null	The exact BIC of the counterparty to retrieve. Only allowed in combination with the iban parameter.
`created_before`	string	Used for pagination, retrieves counterparties created before the given date in ISO 8601 format.
`limit`	number	Used for pagination, sets the number of results to return per page.

RESPONSES

status: OK

[{&quot;id&quot;:&quot;239d6f1f-2222-4ae6-1111-5cc603341b4e&quot;,&quot;name&quot;:&quot;Jane Doe Co.&quot;,&quot;state&quot;:&quot;created&quot;,&quot;created_at&quot;:&quot;2022-09-14T14:47:12.273718Z&quot;,&quot;updated_at&quot;:&quot;2022-09-14T14:47:12.273718Z&quot;,&quot;accounts&quot;:[{&quot;iban&quot;:&quot;GB66REVO00996995908786&quot;,&quot;bic&quot;:&quot;REVOGB21&quot;,&quot;id&quot;:&quot;b209281b-aakk-9911-8d83-ac72469cef8f&quot;,&quot;type&quot;:&quot;external&quot;,&quot;name&quot;:&quot;Jane Doe Co.&quot;,&quot;bank_country&quot;:&quot;GB&quot;,&quot;currency&quot;:&quot;EUR&quot;,&quot;recipient_charges&quot;:&quot;no&quot;}]},{&quot;id&quot;:&quot;8e0e9886-0af1-4b0c-acf4-111180d2892b&quot;,&quot;name&quot;:&quot;John Smith&quot;,&quot;revtag&quot;:&quot;johnsmith&quot;,&quot;profile_type&quot;:&quot;personal&quot;,&quot;country&quot;:&quot;GB&quot;,&quot;state&quot;:&quot;created&quot;,&quot;created_at&quot;:&quot;2022-09-14T14:41:39.312017Z&quot;,&quot;updated_at&quot;:&quot;2022-09-14T14:41:39.312017Z&quot;},{&quot;id&quot;:&quot;e7e36cce-2e9c-4e96-818e-1c2fed325852&quot;,&quot;name&quot;:&quot;John Doe Co.&quot;,&quot;state&quot;:&quot;created&quot;,&quot;created_at&quot;:&quot;2022-08-14T14:34:11.168340Z&quot;,&quot;updated_at&quot;:&quot;2022-08-14T14:34:11.168340Z&quot;,&quot;accounts&quot;:[{&quot;account_no&quot;:&quot;12345674&quot;,&quot;sort_code&quot;:&quot;540107&quot;,&quot;id&quot;:&quot;e277b2bd-3a6d-423b-933d-3d425094bb13&quot;,&quot;type&quot;:&quot;external&quot;,&quot;name&quot;:&quot;John Doe Co.&quot;,&quot;bank_country&quot;:&quot;GB&quot;,&quot;currency&quot;:&quot;GBP&quot;,&quot;recipient_charges&quot;:&quot;no&quot;}]},{&quot;id&quot;:&quot;239d6f1f-2222-4ae6-1111-5cc603341b4e&quot;,&quot;name&quot;:&quot;John Smith Co.&quot;,&quot;state&quot;:&quot;created&quot;,&quot;created_at&quot;:&quot;2022-09-14T14:47:12.273718Z&quot;,&quot;updated_at&quot;:&quot;2022-09-14T14:47:12.273718Z&quot;,&quot;accounts&quot;:[{&quot;iban&quot;:&quot;FR1420041010050500013M02606&quot;,&quot;bic&quot;:&quot;PSSTFRPPLIL&quot;,&quot;id&quot;:&quot;b209281b-aakk-9911-8d83-ac72469cef8f&quot;,&quot;type&quot;:&quot;external&quot;,&quot;name&quot;:&quot;John Smith Co.&quot;,&quot;bank_country&quot;:&quot;FR&quot;,&quot;currency&quot;:&quot;EUR&quot;,&quot;recipient_charges&quot;:&quot;no&quot;}]},{&quot;id&quot;:&quot;173e6a6b-d955-465f-8f31-7f6f7c03927c&quot;,&quot;name&quot;:&quot;Johann Meier Co.&quot;,&quot;state&quot;:&quot;created&quot;,&quot;created_at&quot;:&quot;2023-08-10T12:43:20.273500Z&quot;,&quot;updated_at&quot;:&quot;2023-08-10T12:43:20.273500Z&quot;,&quot;accounts&quot;:[{&quot;iban&quot;:&quot;CH5604835012345678009&quot;,&quot;bic&quot;:&quot;UBSWCHZH80A&quot;,&quot;id&quot;:&quot;b3cc43e8-f141-459b-9bd5-3505cf9797f8&quot;,&quot;type&quot;:&quot;external&quot;,&quot;name&quot;:&quot;Johann Meier Co.&quot;,&quot;bank_country&quot;:&quot;CH&quot;,&quot;currency&quot;:&quot;EUR&quot;,&quot;recipient_charges&quot;:&quot;no&quot;}]}]