Returns a list of Roles
JavaScript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}}; fetch('http://{defaultHost}/api/v2/platform/roles', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
{ "data": [ { "id": "1", "type": "role", "attributes": { "name": "Role 1", "created_at": "2022-11-08T19:35:06.596Z", "updated_at": "2022-11-08T19:35:06.596Z" } }, { "id": "2", "type": "role", "attributes": { "name": "Role 2", "created_at": "2022-11-08T19:35:06.597Z", "updated_at": "2022-11-08T19:35:06.597Z" } } ], "meta": { "count": 2, "total_count": 2, "total_pages": 1 }, "links": { "self": "http://www.example.com/api/v2/platform/roles?page=1&per_page=&filter[name_eq]=", "next": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=", "prev": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=", "last": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=", "first": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=" } }
Documentation IndexFetch the complete documentation index at: https://spreecommerce.org/docs/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Records returned
Show child attributes
Was this page helpful?
Contact support