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

Wraps

getOrganizationWrapStyles

Code samples

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

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

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

GET /organization/wrapstyles

Retrieve a list of organization wrap styles with optional filters

Retrieves a specific wrap by ID.

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Bearer token for authorization
hoseId	query	string	false	Filter wrap styles by hose ID (MongoDB ObjectId)
customerId	query	string	false	Filter wrap styles by customer ID (MongoDB ObjectId)
showAllOptions	query	boolean	false	Flag to show all options, including unavailable ones

Example responses

500 Response

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "List of wrap objects",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "image": {
            "type": "string",
            "nullable": true
          }
        }
      }
    },
    "total": {
      "type": "integer"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	List of organization wrap styles	None
500	Internal Server Error	A list of wrap options	Inline

Response Schema

Status Code 500

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