/organization/customhoses v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Hoses
getOrganizationCustomHoses
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/organization/customhoses", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /organization/customhoses
Gets custom hose options for this organization
Retrieves hoses accessible to the organization, supporting filtering, sorting, and pagination.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| size | query | string | false | An optional string parameter for size. |
| nominalHoseSize | query | string | false | An optional string parameter for nominal hose size. |
| search.size | query | string | false | An optional string parameter for size within search. |
| search.nominalHoseSize | query | string | false | An optional string parameter for nominal hose size within search. |
| search.spec | query | string | false | An optional string parameter for specification within search. |
| search.brand | query | string | false | An optional string parameter for brand within search. |
| search.orgPartNumber | query | string | false | An optional string parameter for original part number within search. |
| customerId | query | string(mongo-id) | false | An optional MongoDB ID for customer. |
| hideUnavailable | query | boolean | false | An optional boolean parameter to hide unavailable items. |
| hideUnavailableBrands | query | boolean | false | An optional boolean parameter to hide unavailable brands. |
Example responses
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | An array of hoses | None |
