/organization/adaptors 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

Adaptors

getOrganizationAdaptors

Code samples

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

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

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

GET /organization/adaptors

Gets adaptors available to this organization

Retrieves all standard GoldLeaf adaptors accessible by the current organization. Custom adaptors can also be included using the includeCustom flag.

Parameters

Name	In	Type	Required	Description
search.partNumber	query	string	false	Filter by part number.
search.brand	query	string	false	Filter by brand.
search.description	query	string	false	Filter by description.
search.searchText	query	string	false	Search across part number, brand, and description. If used, other search fields are ignored.
search.shape	query	string	false	Filter by shape.
search.ends	query	string	false	Filter by ends.
search.orgPartNumber	query	string	false	Filter by organization part number.
search.exactPartNumber	query	string	false	Filter by exact part number.
customerId	query	string(mongo-id)	false	MongoDB ID of the customer.
hideUnavailable	query	boolean	false	Whether to hide unavailable items.
hideUnavailableBrands	query	boolean	false	Whether to hide items from unavailable brands.
includeCustom	query	boolean	false	Whether to include custom adaptors in the response.

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": false
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A response object containing a list of adaptors and total count.	Inline
500	Internal Server Error	Server error	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» items	array	false	none	none
»» anonymous	any	false	none	none

Status Code 500

Name	Type	Required	Restrictions	Description
» item	object	false	none	none
»» name	string	false	none	none
»» image	string¦null	false	none	none
» total	number	false	none	none