/organization/ferrule 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:
Ferrules
getOrganizationFerrule
Code samples
const headers = {
Accept: "application/json",
};
fetch("https://goldleaf.app/api/v1/organization/ferrule?partNumber=type,string", {
method: "GET",
headers: headers,
})
.then(function (res) {
return res.json();
})
.then(function (body) {
console.log(body);
});
GET /organization/ferrule
Gets a ferrule
Retrieves a specific ferrule by part number.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| partNumber | query | string | true | The part number, must be a non-empty string. |
| includeCustom | query | boolean | false | Flag to include custom parts, optional and can be nullable. |
Example responses
500 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A ferrule | None |
| 500 | Internal Server Error | Server error | string |
