Get Quote List

Retrieve Quotes

This endpoint allows you to retrieve a list of quotes from the resource database. You can specify the order, pagination, and the fields you want to include in the response.

Request Parameters

  • order_by (string): Specifies the order in which the results should be returned. In this case, it is set to creation desc, meaning the results will be ordered by the creation date in descending order.

  • limit_page_length (integer): Defines the maximum number of records to return in the response. Here, it is set to 20, which means up to 20 quotes will be returned.

  • limit_start (integer): Indicates the starting point for the records to be returned. In this case, it is set to 20, which means the results will start from the 21st record.

  • fields (array of strings): Specifies the fields to be included in the response. In this example, the fields requested are name, status, and buyer_name.

Expected Response

The response will contain a JSON object with a data key, which is an array of quote objects. Each object will include the requested fields:

{
  "data": [
    {
      "name": "",
      "status": "",
      "buyer_name": ""
    }
  ]
}

Notes

  • Ensure that the parameters are correctly formatted to avoid errors in the request.

  • The response may contain empty strings for the fields if no data is available for those quotes.

  • Adjust the limit_page_length and limit_start parameters to navigate through larger datasets effectively.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Parameters

  • order_by (string): Specifies the order in which the results should be returned.
    Example: creation desc : results will be ordered by the creation date in descending order.

  • limit_page_length (integer): Defines the maximum number of records to return in the response.
    Example: 20 : up to 20 quotes will be returned.

  • limit_start (integer): Indicates the starting point for the records to be returned.
    Example: 20 : results will start from the 21st record.

  • fields (array of strings): Specifies the fields to be included in the response.
    Example: ["name", "status", "buyer_name"] : only these fields will be included for each quote.

Expected Response

The response will contain a JSON object with a data key, which is an array of quote objects. Each object will include the requested fields:

{
  "data": [
    {
      "name": "",
      "status": "",
      "buyer_name": ""
    }
  ]
}
Query Params
string

Orders the results by a variable and asc/desc

integer

By default, 20 records are loaded.

integer

Skip the first 'n'

string

Fields that you want to fetch. "name" is the primary key or ID of the document

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json