Counterpartiesv1Counterparty Contacts
List contacts
Returns counterparty contacts visible to the requesting user in the standard Corebanq getAll response shape.
GET
/v1/counterparties/contactsAuthorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
limit?integer
Maximum number of rows to return.
offset?integer
Number of rows to skip before collecting the result set.
sort?string
Sorting instructions using the shared getAll format, for example -created_at or name,-modified_at.
filter?string
Optional JSON object with structured filters.
search.id?string
Filter by contact identifier.
search.counterparty_id?string
Filter by parent counterparty identifier.
search.type?string
Filter by contact channel type.
search.value?string
Filter by contact value.
search.validated?boolean
Filter by validated flag.
search.preferred?boolean
Filter by preferred flag.
search.active?boolean
Filter by active flag.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/counterparties/contacts"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"counterparty_id": "fd38dae9-b300-4017-a630-101c4279eafd",
"type": "string",
"value": "string",
"validated": true,
"preferred": true,
"active": true,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"modified_at": "2019-08-24T14:15:22Z",
"modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f",
"metadata": {}
}
],
"total": 0,
"total_unfiltered": 0,
"has_more": true
}{
"error": "string",
"message": "string",
"details": {}
}{
"error": "string",
"message": "string",
"details": {}
}{
"error": "string",
"message": "string",
"details": {}
}{
"error": "string",
"message": "string",
"details": {}
}