List blog categories
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/blog/categories?sort_order=asc&filters=%5B%7B%22field%22%3A%22post_count%22%2C%22operator%22%3A%22lte%22%2C%22values%22%3A%5B%220%22%5D%7D%5D';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
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://apibase.ecomweb.app/api/v1/stores/example/blog/categories?sort_order=asc&filters=%5B%7B%22field%22%3A%22post_count%22%2C%22operator%22%3A%22lte%22%2C%22values%22%3A%5B%220%22%5D%7D%5D' \ --header 'x-api-key: <x-api-key>'Returns the store’s blog categories with the number of posts in each, ordered by sort_order by default. Search by name or slug, sort, or pass filters for list-view filters. Paginated with limit (default 20) and offset.
Required scopes: read:blog
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Free-text search over name and slug.
Field to sort by: name, slug, sort_order, created_at, updated_at or post_count. Defaults to sort_order.
Sort direction.
Maximum number of items to return, at least 1. Defaults to 20 on the store list.
Number of items to skip. Defaults to 0.
Include each item’s post_count. The store list always includes it.
Example
[{"field":"post_count","operator":"lte","values":["0"]}]Admin list-view filters, a JSON array of {field, operator, values}. At most 10 clauses, at most 50 values each.
Responses
Section titled “Responses”object
object
Description, or null.
Hex colour such as #ff6600, or null.
Manual position in the category list; lower comes first.
Category ID.
Display name.
URL slug, unique within the store.
Number of posts in the category. Present when post counts are included; always present on the paginated list.
When the category was created, as an ISO 8601 timestamp.
When the category was last updated, as an ISO 8601 timestamp.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
Example generated
{ "data": [ { "description": "example", "color": "example", "sort_order": 1, "id": 1, "name": "example", "slug": "example", "post_count": 1, "created_at": "example", "updated_at": "example" } ], "meta": { "total": 1, "limit": 1, "offset": 1, "page": 1, "totalPages": 1, "hasNext": true, "hasPrev": true }}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}