younifyd
Menu

List Groups

List groups

GET/api/1/groups

Use it in a workflow

  1. Add a step and choose the Bynder connector.
  2. Pick the List Groups action (under Groups).
  3. Fill in the fields below, then reference the result from later steps as {{listGroups.response.data}}.

Request

Query parameters

search_termstring

Filter groups by matching name.

ids[]array<string (uuid)>

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

sortstring

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

One ofnamedescription-name-descriptionDefault "name"

startinteger

Page number (1-based).

Default 1

limitinteger

Number of results per page.

Default 20

Response

Returns 200 with an object. Read it in later steps with {{listGroups.response.data.<field>}}.

itemsarray<object>
idstring (uuid)
namestring
descriptionstring | null
user_countinteger

Number of members in the group.

metadataobject
prevPagestring | null

Relative URL of the previous page, or null if on the first page.

nextPagestring | null

Relative URL of the next page, or null if on the last page.

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

Need more? See the Bynder guide for connection setup and behaviour shared by every action.