/hosekits 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:
Hose Kits
getHoseKits
Code samples
const headers = {
Accept: "application/json",
Authorization: {
type: "string",
},
};
fetch("https://goldleaf.app/api/v1/hosekits", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /hosekits
Retrieve hose kits with search and pagination
Retrieves all hose kits based on optional search criteria, supports pagination and filtering by customer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token for authentication |
| search.customerName | query | string | false | Search by customer name |
| search.description | query | string | false | Search by description |
| search.status | query | string | false | Search by status |
| search.commonSearch | query | string | false | General search field |
| search.customerPartNumberWithRevision | query | string | false | Search by customer part number with revision |
| search.partNumberWithRevision | query | string | false | Search by part number with revision |
| status | query | array[string] | false | Filter by an array of statuses |
| customerOrgId | query | string(objectId) | false | Filter by customer organization ID |
| hoseKitId | query | string(objectId) | false | Filter by hose kit ID |
| hoseAssemblyId | query | string(objectId) | false | Filter by hose assembly ID |
| workOrderId | query | string(objectId) | false | Filter by work order ID |
| onlyCustomer | query | boolean | false | If true, limits results to customer-specific kits |
| page | query | integer | false | Page number for pagination |
| pageSize | query | integer | false | Number of items per page |
Example responses
500 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of hose kits | None |
| 500 | Internal Server Error | Internal server error | string |
