curl --request GET \
--url http://{defaultHost}/api/v2/platform/promotion_categories \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "1",
"type": "promotion_category",
"attributes": {
"name": "Promotion Category",
"created_at": "2022-11-08T19:34:58.013Z",
"updated_at": "2022-11-08T19:34:58.013Z",
"code": "POP123"
},
"relationships": {
"promotions": {
"data": []
}
}
},
{
"id": "2",
"type": "promotion_category",
"attributes": {
"name": "Promotion Category",
"created_at": "2022-11-08T19:34:58.014Z",
"updated_at": "2022-11-08T19:34:58.014Z",
"code": "POP123"
},
"relationships": {
"promotions": {
"data": []
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/promotion_categories?page=1&per_page=&include=&filter[code_eq]=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page="
}
}Returns a list of Promotion Categories
curl --request GET \
--url http://{defaultHost}/api/v2/platform/promotion_categories \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "1",
"type": "promotion_category",
"attributes": {
"name": "Promotion Category",
"created_at": "2022-11-08T19:34:58.013Z",
"updated_at": "2022-11-08T19:34:58.013Z",
"code": "POP123"
},
"relationships": {
"promotions": {
"data": []
}
}
},
{
"id": "2",
"type": "promotion_category",
"attributes": {
"name": "Promotion Category",
"created_at": "2022-11-08T19:34:58.014Z",
"updated_at": "2022-11-08T19:34:58.014Z",
"code": "POP123"
},
"relationships": {
"promotions": {
"data": []
}
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/promotion_categories?page=1&per_page=&include=&filter[code_eq]=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/promotion_categories?filter%5Bcode_eq%5D=&filter%5Bname_eq%5D=&include=&page=1&per_page="
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes
Records returned
Was this page helpful?