List the listing attributes

GET

/listings/attributes

const url = 'https://acme.mykreezalid.com/front_api/v1/listings/attributes?tags=size%2Ccolor&page=1&limit=75';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://acme.mykreezalid.com/front_api/v1/listings/attributes?tags=size%2Ccolor&page=1&limit=75'

Returns the custom fields the marketplace defines for its listings, sorted by sort_priority, 75 per page. Works without an access token; a token changes nothing.

Parameters

Query Parameters

tags

string

Only return attributes that have at least one of these tags, as a comma-separated list (or repeated tags[] parameters).

Example

size,color

page

integer

default: 1 >= 1

Page to return, starting at 1.

limit

integer

default: 75 >= 1 <= 100

Number of attributes per page (at most 100).

Responses

200

The attributes.

application/json

object

attributes

Array<object>

A custom field the marketplace defines for its listings.

object

integer

alias

Key of the attribute in a listing’s attributes.

string

title

Label of the attribute. May contain HTML set by the marketplace.

string

sanitized_title

Label of the attribute with HTML removed (icon tags <i> are kept).

string

nullable

input_type

Kind of input, for example select or checkbox for attributes with a list of options.

string

required

Whether a value is required.

boolean

searchable

Whether the value is used by the marketplace search.

boolean

search_filter

Whether the attribute is offered as a search filter.

boolean

sort_priority

Display order; the list is sorted on it.

integer

nullable

pagination

Paging information, added next to the results of a paginated list. Request another page with the page query parameter and change the page size with limit (at most 100).

object

totalResultsCount

Number of results across all pages.

integer

currentPage

Number of the page returned, starting at 1.

integer

nextPage

Whether a next page exists.

boolean

prevPage

Whether a previous page exists.

boolean

resultOnPageCount

Number of results on this page.

integer

pageCount

Number of pages.

integer

Example

{
  "attributes": [
    {
      "id": 91,
      "alias": "color",
      "title": "Color",
      "sanitized_title": "Color",
      "input_type": "select",
      "sort_priority": 1
    }
  ],
  "pagination": {
    "totalResultsCount": 137,
    "currentPage": 1,
    "resultOnPageCount": 25,
    "pageCount": 6
  }
}