Get counterparty
curl --request GET \
--url https://breadbox.example.com/api/v1/counterparties/{id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"website_url": "<string>",
"logo_url": "<string>",
"category_id": "<string>",
"mcc": "<string>",
"canonical_counterparty_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Get counterparty
Get counterparty
curl --request GET \
--url https://breadbox.example.com/api/v1/counterparties/{id} \
--header 'X-API-Key: <api-key>'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"website_url": "<string>",
"logo_url": "<string>",
"category_id": "<string>",
"mcc": "<string>",
"canonical_counterparty_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Breadbox API key with format bb_<base62>. Carries either read_only
or full_access scope. Write endpoints (and a handful of sensitive
reads — /api-keys, /users/{user_id}/login) require full_access;
endpoints that require it are flagged in their description.
Path Parameters
Response
Counterparty.
The canonical, cross-provider "other side" of a charge (a merchant or non-merchant). Surrogate identity + name + optional enrichment; membership comes from assign_counterparty rules, not a normalizer.
Last modified on June 24, 2026
⌘I