HPH Integrations APIv1 · Customer Testing
Customer Testing. Available to the Customer Testing group. Production is not available. Environment and onboarding details are provided directly, never in this documentation.
ListMaterialVendors

List material vendors

List up to 50 active material vendors attached to the represented Company's account.

GET/v1/vendors

Request schema: None
Success schema: MaterialVendorCollectionResponseV1
Documented HTTP statuses: 200, 400, 401, 403, 404, 409, 429, 503
Contract: vendor-directory-v1.openapi.json

Authorization

Current Enterprise authority and direct-Company caller context are required. Partner-application access is not supported.

Request guidance

The operation accepts no status, page, or org_id query parameter. The represented Company comes from the authenticated caller context, and only active vendors are returned.

Request body

This operation has no JSON request body.

Idempotency and recovery

No idempotency key is used because this operation is read-only.

Response guidance

code is nullable. transaction_pipeline_available reports whether the vendor can transact through the HPH transaction pipeline. branch_location is human-readable text. The collection is limited to 50 vendors with no paging; a directory that would exceed the limit fails instead of being truncated. vendor_skey is an opaque stable value and is not required to be a UUID.

Synthetic success example: Active material vendors

{
  "contract_version": "v1",
  "evaluated_at": "2026-10-29T16:00:00Z",
  "vendors": [
    {
      "vendor_skey": "vendor-syn-001",
      "code": "SYN",
      "name": "Synthetic Supply Company",
      "vendor_type": "Material Supplier",
      "status": "active",
      "transaction_pipeline_available": true,
      "logo_url": "https://assets.example.test/vendor.png",
      "branch_location": "Cincinnati Main Branch",
      "address": {
        "address_1": "123 Main Street",
        "address_2": null,
        "address_3": null,
        "city": "Cincinnati",
        "state": "OH",
        "postal_code": "45202"
      },
      "contact": {
        "telephone": "555-555-0100",
        "quote_request_email": "quotes@example.test",
        "website": "https://example.test"
      },
      "account_count": 2
    }
  ],
  "vendor_count": 1
}