/organization/ferrules 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:

https://goldleaf.app/api/v1

Ferrules

getOrganizationFerrules

Code samples

const headers = {
  Accept: "application/json",
};

fetch("https://goldleaf.app/api/v1/organization/ferrules", {
  method: "GET",

  headers: headers,
})
  .then(function (res) {
    return res.json();
  })
  .then(function (body) {
    console.log(body);
  });

GET /organization/ferrules

Gets ferrules

Gets ferrules for this organization.

Parameters

Name	In	Type	Required	Description
size	query	string	false	The size to search for.
brand	query	string	false	The brand to search for.
search.brand	query	string	false	The brand to search for within a specific search context.
search.partNumber	query	string	false	The part number to search for within a specific search context.
search.size	query	string	false	The size to search for within a specific search context.
search.orgPartNumber	query	string	false	The original part number to search for within a specific search context.
customerId	query	string(mongo-id)	false	The MongoDB ID of the customer.
hideUnavailable	query	boolean	false	Flag to hide unavailable items.
hideUnavailableBrands	query	boolean	false	Flag to hide brands with unavailable items.
includeCustom	query	boolean	false	Flag to include custom items.
orSearch	query	boolean	false	Flag to perform an OR search.

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	An array of ferrules	None

/organization/ferrules v1.0.0

Ferrules

getOrganizationFerrules

Parameters

Responses

Response Schema