POST

Query Badges

Retrieves up to 1000 badges, given the requested query options, paging, and sorting. 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
POST
https://www.wixapis.com/members/v3/badges/query
Body Params
filterstruct

Filter options. Currently supported fields for filtering:

sortArray <Sorting>

Sorting options. For more details on how to use sorting, see API Query Language: The Sort Section

pagingPaging

Pagination options. For more information, see API Query Language: The Paging Section.

Response Object
badgesArray <Badge>

List of badges.

metadataMetadata

Metadata for the paginated results.

Retrieving all badges by passing an empty filter

Request
cURL
curl -X POST 'https://www.wixapis.com/members/v3/badges/query' \
    -H 'Authorization: <AUTH>'
    -d '{
  "filter": {},
  "sorting": [],
  "paging": {}
}'
Response
JSON
{
  "badges": [
    {
      "id": "91e9c1ac-aea4-4329-84ef-093c55595cde",
      "title": "Top Contributor",
      "description": "Contributed most posts this month",
      "backgroundColor": "#796EFF",
      "textColor": "#FFFFFF",
      "icon": "",
      "permissionsEnabled": false,
      "slug": "top-contributor",
      "createdDate": "2021-10-18T12:07:43.560Z",
      "updatedDate": "2021-10-18T12:07:43.560Z"
    },
    {
      "id": "0f223639-56a5-4e09-b785-d80392c413ed",
      "title": "Conversation Starter",
      "description": "Added the first comment on a post.",
      "backgroundColor": "#796EFF",
      "textColor": "#FFFFFF",
      "icon": "",
      "permissionsEnabled": false,
      "slug": "conversation-starter",
      "createdDate": "2021-10-18T12:08:13.191Z",
      "updatedDate": "2021-10-18T12:08:13.191Z"
    },
    {
      "id": "fdcbd071-f943-4bb2-bf6d-001bbb9dc495",
      "title": "Community Builder",
      "description": "Special access and moderation permissions.",
      "backgroundColor": "#796EFF",
      "textColor": "#FFFFFF",
      "icon": "",
      "permissionsEnabled": false,
      "slug": "community-builder",
      "createdDate": "2021-10-18T12:08:44.930Z",
      "updatedDate": "2021-10-18T12:08:44.930Z"
    }
  ],
  "metadata": {
    "count": 3,
    "total": 3
  }
}
Errors

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

Did this help?