Groups

List workspace groups

Returns groups derived from workspace contact graph data, enriched with cached invite-link and member-count metadata when available.

get/v1/groups

Request

  • Base URL: https://api.entergram.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.entergram.com/v1/groups
  • Auth: API key in header X-API-Key

Query parameters

limitinteger

Number of groups to return per page.

Example:50
offsetinteger

Zero-based offset for pagination.

searchstring

Case-insensitive search over group id, title, and username.

Example:community
member_idstring

Optional filter for groups exposed by a specific workspace member id.

Example:user_demo_123
account_idstring

Optional filter for groups exposed by a specific connected account id.

Example:acct_demo_123
chat_typestring

Optional exact chat-type filter.

Example:group

Response

OK

Example response

{
  "data": {
    "items": [
      {
        "chatType": "group",
        "contactCount": 12,
        "displayName": "Community Alpha",
        "groupId": "-1000001234567",
        "inviteLink": "https://t.me/+sampleinvite123",
        "knownByAccounts": [
          {
            "accountId": "acct_demo_123",
            "displayName": "Ops Sample",
            "ownerDisplayName": "Alex Example",
            "ownerUserId": "user_demo_123",
            "role": "member",
            "username": "ops_sample"
          }
        ],
        "memberCount": 245,
        "participantCount": 245,
        "username": "samplecommunity"
      }
    ]
  }
}

Changes

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