Sign in

v1

latestOpenAPI 3.1.02026-07-223614164.6 KB
Groups

List groups

Returns a list of workspace groups.

get/v1/groups

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Response

A paginated list of groups in the workspace. The data.items field contains the list of groups, and the data.pagination.nextLink field contains a link to the next page of results, if available.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "name": "Group Name"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/groups?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}