API Reference
Reference for the API
List all categories
cURL
curl --request GET \ --url https://cookiechimp.com/api/v1/categories \ --header 'Authorization: <api-key>'
{ "pagination": { "prev_url": "/api/v1/categories?page=", "next_url": "/api/v1/categories?page=2", "count": 4, "page": 1, "prev": null, "next": 2 }, "data": [ { "id": "essential", "name": "Essential", "description": "Cookies essential for website functionality", "required": true, "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-02T00:00:00Z" } ] }
Number of resources to return
1 <= x <= 100
Number of resources to skip
x >= 0
Field to sort by
Sort order
asc
desc
List of categories
Show child attributes
Path to get previous page
Path to get next page
Total number of pages
Current page
Previous page number
Next page number
{ "prev_url": "/api/v1/categories?page=", "next_url": "/api/v1/categories?page=2", "count": 4, "page": 1, "prev": null, "next": 2}
Name of the category that is displayed to users
Description of the category that is displayed to users
Whether the category is required for the website to function
Unique identifier for the category
Date and time when the category was created
Date and time when the category was last updated
Was this page helpful?