Categories module
This module provides access to manage the list of categories and view their details.
URL Format
You can use GET or POST variables in your requests.
baseUrl/categories.php?action=ACTION¶ms...
Reference
Some responses may return defined objects inside the JSON that refer to existing classes.
See related:
Pagination
All requests that return lists can support pagination. Add page=PAGE_NUMBER
and limit=[1-1000|default:30]
(limit per page) to paginate the responses.
List of actions
The parameter "action" determines the action you would like to match. See below list.
list
List all categories within specified parameters. Result is always sorted by category ID, descending.
Parameters:
- categoryId: integer (optional), comma-separated IDs of categories to return as a collection
- typeId: integer (optional) a type ID for the categories you want to list. Types are typically different publications you have.
- parentId: integer (optional) list only categories under a specific category. Special value: string "null" to only show top-level categories
- includeInIssue: 1/0 (optional) filter categories by whether they're included in your categorized articles per issue
Response:
data: [ { Category object } ]
view
Return a category's details.
Parameters:
- categoryId: int, ID of the category
Response:
data: [ { Category object } ]