GET

List Categories


Retrieves a list of up to 100 categories per request.

List Categories runs with these defaults, which you can override:

  • paging.limit is 50.
  • paging.offset is 0.

List Categories is sorted by displayPosition in descending order. This cannot be overridden.

Permissions
Manage Blog
Read Blog
Read Draft Blog Posts
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/blog/v3/categories

Query Params
paging.offsetintegerminimum 0

Number of items to skip in the current sort order.

Default: 0


paging.limitintegerminimum 1maximum 100

Number of items to return.

Default:50


paging.cursorstringmaxLength 2000

Pointer to the next or previous page in the list of results.


fieldsetsArray <string>

List of additional category fields to include in the response. For example, use the URL fieldset to retrieve the url field in the response in addition to the category’s base fields. Base fields don’t include any of the supported fieldset values. By default only the category’s base fields are returned.


languagestring

Language filter.

2-or-4-letter language code in IETF BCP 47 language tag format. Pass a language to only receive categories that are in that language. If omitted, categories in all languages are returned.

Response Object
categoriesArray <Category>

List of categories.


metaDataMetaData

Details on the paged set of results returned.

List Categories Example 1
Request
cURL
curl \ 'https://www.wixapis.com/blog/v3/categories?fieldsets=URL' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "categories": [ { "id": "5f2bcaa0879ad500173577f3", "label": "Summer", "url": { "base": "https://some.wixsite.com/something-to-prod/blog", "path": "/blog/categories/summer" }, "postCount": 17, "description": "Posts about my summer", "title": "Summer", "displayPosition": 1, "slug": "summer-slug", "language": "en", "translationId": "111a58a2-dc75-422d-9ca6-00a489750dfd" } ], "pagingMetadata": { "count": 1, "hasNext": false, "offset": 0, "total": 1 } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?