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

CrimpFittings

getOrganizationCustomCrimpFittings

Code samples

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

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

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

GET /organization/customcrimpfittings

Get custom crimp fittings for the organization

Retrieves all custom GoldLeaf crimp fittings accessible by this organization, optionally filtered by parameters.

Parameters

Name	In	Type	Required	Description
dashSize	query	string	false	Dash size of the part.
hoseSize	query	string	false	Hose size.
nominalHoseSize	query	string	false	Nominal hose size.
search.partNumber	query	string	false	Part number to search for.
search.brand	query	string	false	Brand to search for.
search.series	query	string	false	Series to search for.
search.dashSize	query	string	false	Dash size to search for.
search.hoseSize	query	string	false	Hose size to search for.
search.nominalHoseSize	query	string	false	Nominal hose size to search for.
search.orgPartNumber	query	string	false	Original part number to search for.
customerId	query	string	false	MongoDB ID of the customer.
hideUnavailable	query	boolean	false	If true, hides unavailable items.
hideUnavailableBrands	query	boolean	false	If true, hides brands with unavailable items.

Example responses

500 Response

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "image": {
            "type": "string",
            "nullable": true
          }
        }
      }
    },
    "total": {
      "type": "integer"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A list of custom crimp fittings.	None
500	Internal Server Error	Server error with default response.	Inline

Response Schema

Status Code 500

Name	Type	Required	Restrictions	Description
» items	[object]	false	none	none
»» name	string	false	none	none
»» image	string¦null	false	none	none
» total	integer	false	none	none