FOfolk
Groups

List groups

Changed on

Returns a list of workspace groups.

get/v1/groups

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/groups
  • Auth
    HTTP bearer

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.

Workspace owners and admins get every group in the workspace, including private groups they are not a member of. Other members only get the groups they have access to: their own private groups, the shared groups they are a member of, and the groups shared with everyone. Being able to see a group in this list does not grant access to its contents: the group members, custom fields and contacts endpoints still require access to that specific group.

deprecationsstring[]

Example response

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

Changes

  • c6818f3ba60dRevision changes
    • info

      the response property / became required for the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status