List contacts
Returns counterparty contacts visible to the requesting user in the standard Corebanq getAll response shape.
Authorization
bearerAuth In: header
Query Parameters
Maximum number of rows to return. Defaults to 10 and is capped at 100 by the shared query parser.
Number of rows to skip before collecting the result set.
Sorting instructions using the shared getAll format, for example -created_at or name,-modified_at.
Optional JSON object with structured filters.
Filter by contact identifier.
Filter by parent counterparty identifier.
Filter by contact channel type.
Filter by contact value.
Filter by validated flag.
Filter by preferred flag.
Filter by active flag.
Group results by this field; data becomes an object keyed by the field's values and keys lists the group keys.
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,
"metadata": {},
"keys": [
"string"
]
}{
"status": 400,
"message": "Invalid input"
}{
"status": 401,
"message": "Unauthorized"
}{
"status": 403,
"message": "Forbidden"
}{
"status": 500,
"message": "server_error"
}Partially updates mutable bank account fields. Omitted fields remain unchanged. If the bank account is currently inactive (active=false), the caller must hold the Internal role to update it; otherwise the row is treated as not found and the request returns 404 Not Found. This check is enforced atomically inside the update transaction via a row lock (SELECT ... FOR UPDATE).
Next Page