List categories for listings

GET

/listings/categories

const url = 'https://acme.mykreezalid.com/api/v1/listings/categories?page=1&limit=25';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

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/api/v1/listings/categories?page=1&limit=25' \
  --header 'Authorization: Basic <credentials>'

Returns the listing categories of your marketplace as a flat list, to pick a category_id before you create a listing. The list is paginated with page and limit, without a pagination block in the response.

Authorizations

basic

Parameters

Query Parameters

page

integer

default: 1 >= 1

Page number, starting at 1.

limit

integer

default: 25 >= 1 <= 100

Number of results per page (at most 100).

Responses

200

Your categories

application/json

object

categories

Array<object>

object

integer

title

string

page_title

string

nullable

description

string

nullable

slug

string

nullable

listing_count

Number of listings in the category

integer

nullable

url

Path of the category page on your marketplace

string

nullable

admin_url

Path of the category in your admin panel

string

nullable

Example

{
  "categories": [
    {
      "id": 4242,
      "title": "Shoes",
      "slug": "shoes",
      "listing_count": 42,
      "url": "/c/shoes"
    }
  ]
}

403

Missing or wrong API credentials

404

The requested page does not exist