GET

List Badges


Retrieves up to 1000 badges, given the requested paging. Default paging.limit is 100, paging.offset - 0. For more information, see API Query Language: The Paging Section.

Permissions
Manage Badges
Read Badges
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/members/v3/badges

Query Params
paging.limitintegerminimum 0format int32

Number of items to load.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

Response Object
badgesArray <Badge>

List of badges.


metadataMetadata

Metadata for the paginated results.

List badges

Retrieving badges

Request
cURL
curl -X GET \ 'https://www.wixapis.com/members/v3/badges?paging.limit=4&paging.offset=1' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "badges": [ { "id": "ce700e2e-ded6-4e30-9638-6be7a9eec91b", "title": "VIP", "description": "", "backgroundColor": "#796EFF", "textColor": "#FFFFFF", "icon": "", "permissionsEnabled": false, "slug": "vip", "createdDate": "2020-05-27T12:19:06.978Z", "updatedDate": "2020-05-27T12:19:06.978Z" }, { "id": "99b12184-d3c3-441a-8659-789e0007b634", "title": "Moderator", "description": "Moderator", "backgroundColor": "#796EFF", "textColor": "#FFFFFF", "icon": "", "permissionsEnabled": false, "slug": "moderator", "createdDate": "2020-05-27T12:18:08.329Z", "updatedDate": "2020-05-27T12:18:08.329Z" }, { "id": "ffdc5c7d-d080-4c7c-869e-a8c4478532c0", "title": "MVP", "description": "Most valuable player", "backgroundColor": "#796EFF", "textColor": "#FFFFFF", "icon": "", "permissionsEnabled": false, "slug": "mvp", "createdDate": "2020-05-27T12:17:54.024Z", "updatedDate": "2020-05-27T12:17:54.024Z" }, { "id": "80d5e4aa-0ab2-4bab-b941-a7459239a02e", "title": "Awesome Badge", "description": "Badge for awesome people", "backgroundColor": "#FFFFFF", "textColor": "#FF0000", "icon": "https://my-icons.example/awesome.svg", "permissionsEnabled": false, "slug": "awesome-badge", "createdDate": "2020-05-28T09:26:17.699Z", "updatedDate": "2020-05-28T09:26:17.699Z" } ], "metadata": { "count": 4, "offset": 1, "total": 10, "tooManyToCount": false } }
Errors

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

Did this help?