Groups (Preferred)

List groups

Returns a paginated list of groups with member count.

Requires the GROUPMANAGEMENT security role.

get/api/1/groups

Request

Base URL
https://{your-bynder-domain}
URL
https://{your-bynder-domain}/api/1/groups
Auth
- API key in header Authorization
- or OAuth 2
  Authorization code: https://{your-auth-url}
  Client credentials
  Token URL: https://{your-bynder-domain}/v6/authentication/oauth2/token scopes: GROUPMANAGEMENT

Query parameters

search_termstring

Filter groups by matching name.

ids[]string[]

Filter by specific group IDs (hyphens in the UUIDs are optional).

sort'name' | 'description' | '-name' | '-description'

Sort field and direction. Prefix with - for descending order (e.g. -name).

startinteger

Page number (1-based).

limitinteger

Number of results per page.

Response

Successful response

Example response

{
  "items": [
    {
      "id": "0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a",
      "name": "Marketing",
      "description": "Everyone in the marketing department",
      "user_count": 12
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.