listCategories( )


Retrieves a list of up to 100 categories per request.

If you pass a language filter to the method, it returns a list of up to 100 categories in the requested language.

The categoies are displayed in order of their displayPosition, starting with 0. The displayPosition is the position in which the categories are displayed in the Category Menu page. By default, categories get added to the bottom of the Category Menu page with a displayPosition of -1.

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
Manage Blog
Read Blog
Read Draft Blog Posts
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListCategoriesOptions

Filter and paging options.

Returns
Return Type:Promise<ListCategoriesResponse>
Errors

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

Did this help?