Get a catalog binding
Procurement module
GET/catalog-bindings/{id}catalogBindings.get
A tenant item bound to a canon element. Returns one catalog binding with its `ETag`. A catalog binding the caller may not see returns 404.
- Requires the capability procurement.catalog.read.
- OAuth scopes: procurement.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the catalog binding. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CatalogBinding
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the catalog binding. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| element_id | ItemId | Yes | Catalog item identifier `{URID}-{ORG}-{SEQ}` (Section 3.6).Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}-[A-Z0-9]+-[0-9]+$ |
| item_id | string | Yes | Item ID {URID}-{ORG}-{SEQ}, issued by the database.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| name | string | Yes | Name the org uses for the item.Constraints: length 1 to 300 |
| unit_basis | string | null | Yes | Unit the item is bought in.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_unit_price_minor | integer (int64) | null | Yes | Default unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the default price.Constraints: pattern ^[A-Z]{3}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"element_id": "4000.01.01-XPMS-001",
"item_id": "0000.01.01-NORTHW-001",
"name": "4x8 Stage Deck",
"unit_basis": "ea",
"default_unit_price_minor": 4500,
"currency_code": "USD"
}Code samples
curl -X GET "$XOS_BASE_URL/catalog-bindings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.catalogBindings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.catalog_bindings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos catalog-bindings get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f