/pricelists 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

Price Lists

getPriceList

Code samples

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

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

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

GET /pricelists

Retrieve price lists

Retrieves the price lists associated with the user's organization, supporting search and pagination filters.

Parameters

Name	In	Type	Required	Description
search	query	object	false	Search filters as an object
page	query	integer	false	Page number for pagination
limit	query	integer	false	Number of items per page for pagination

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "The list of items",
      "items": {
        "type": "object",
        "description": "Item object (adjust as needed)"
      }
    },
    "total": {
      "type": "integer",
      "description": "Total number of items"
    },
    "page": {
      "type": "integer",
      "description": "Current page number"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	A paginated list of items	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» items	[object]	false	none	The list of items
» total	integer	false	none	Total number of items
» page	integer	false	none	Current page number