Skip to main content
GET
/
v1
/
communications
/
groups
Lists communications groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "dd914abf-478a-43fb-9aaa-4cff8765a247",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 10",
        "slug": "communication-group-10",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:08.756-07:00",
        "updated_at": "2025-10-20T08:28:08.756-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "bd438f5a-8e36-41d9-b965-9cb1655861e0",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 9",
        "slug": "communication-group-9",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:07.827-07:00",
        "updated_at": "2025-10-20T08:28:07.827-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "d089f2f1-0e47-45f9-bece-d326a4d54ff5",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 8",
        "slug": "communication-group-8",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:06.966-07:00",
        "updated_at": "2025-10-20T08:28:06.966-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "6025b653-0558-4b04-a91c-f1ad5349eb5a",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 7",
        "slug": "communication-group-7",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:05.980-07:00",
        "updated_at": "2025-10-20T08:28:05.980-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "b59fde7c-a5a0-45fb-8e45-17c3d00a369a",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 6",
        "slug": "communication-group-6",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:04.879-07:00",
        "updated_at": "2025-10-20T08:28:04.879-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "e01ebc0f-6d5d-4ac3-999f-056a7c0f4692",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 5",
        "slug": "communication-group-5",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:03.408-07:00",
        "updated_at": "2025-10-20T08:28:03.408-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "5b1b7d41-9f8f-41fe-96ce-9787a7e41879",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 4",
        "slug": "communication-group-4",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:02.552-07:00",
        "updated_at": "2025-10-20T08:28:02.552-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "7cca225f-4a77-48f9-b58f-ba83b694f545",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 3",
        "slug": "communication-group-3",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:01.613-07:00",
        "updated_at": "2025-10-20T08:28:01.613-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "a65c9705-b6eb-498b-8dc7-25eab47e8494",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 2",
        "slug": "communication-group-2",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [],
        "created_at": "2025-10-20T08:28:00.733-07:00",
        "updated_at": "2025-10-20T08:28:00.733-07:00",
        "team_id": 67,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "da7381d1-9d5e-4045-b970-efdd20746240",
      "type": "communications-groups",
      "attributes": {
        "name": "Communication Group 1",
        "slug": "communication-group-1",
        "description": null,
        "is_private": false,
        "condition_type": "any",
        "email_channel": true,
        "sms_channel": false,
        "communication_type_id": "ed25b3e7-f296-4307-bbda-f31700ffd1d8",
        "slack_channel_ids": [
          "0e66e853-2578-5a2d-864a-b51643edb8d7"
        ],
        "created_at": "2025-10-20T08:27:59.871-07:00",
        "updated_at": "2025-10-20T08:27:59.871-07:00",
        "team_id": 67,
        "communication_group_members": [
          {
            "id": "ea25a08f-9d33-4a55-bac9-4662d0d814cd",
            "user_id": 106,
            "name": "Joel Cartwright",
            "email": "luther@johnson.test"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "c532944b-2f0d-48cd-9132-64a89ac1b93f",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "b2370dc0-88b8-4c9f-9a95-93c756fb31c3",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "24024b4d-4797-49ed-821b-299781d696b2",
                "name": "Impedit necessitatibus pariatur et."
              }
            ]
          }
        ]
      }
    }
  ],
  "links": {
    "self": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "first": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "prev": null,
    "next": null,
    "last": "http://www.example.com/v1/communications/groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  },
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_count": 10,
    "total_pages": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]
integer
page[size]
integer
filter[name]
string
filter[slug]
string
filter[is_private]
string
filter[communication_type_id]
string
filter[condition_type]
string
filter[created_at][gt]
string
filter[created_at][gte]
string
filter[created_at][lt]
string
filter[created_at][lte]
string
sort
string

Response

200 - application/vnd.api+json

communications groups found

data
object[]
required
I