GET
/
v1
/
communications
/
groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "36be8415-b8fe-4a50-bacf-a88432f4bdb8",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:58.611-07:00",
        "updated_at": "2025-07-09T07:01:58.611-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "ad4438f6-d41f-4aed-9094-b832590d733e",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:57.458-07:00",
        "updated_at": "2025-07-09T07:01:57.458-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "8a0a01bd-21af-4415-8993-f96d58328353",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:55.670-07:00",
        "updated_at": "2025-07-09T07:01:55.670-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "67b6df8a-85a6-4351-b383-feadd4e644a2",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:54.460-07:00",
        "updated_at": "2025-07-09T07:01:54.460-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "a6e692b1-6bce-4bcc-ae91-1accf3f09821",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:53.227-07:00",
        "updated_at": "2025-07-09T07:01:53.227-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "c3ee9337-3ea4-4f50-8b8d-3432d9388576",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:52.038-07:00",
        "updated_at": "2025-07-09T07:01:52.038-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "23f1bd24-c352-42bc-a8b3-37a294b6696e",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:50.615-07:00",
        "updated_at": "2025-07-09T07:01:50.615-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "8745e229-422f-442b-b726-57b7a4389702",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:49.397-07:00",
        "updated_at": "2025-07-09T07:01:49.397-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "43d52004-f3e2-4131-81a5-d2c42a286613",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [],
        "created_at": "2025-07-09T07:01:47.497-07:00",
        "updated_at": "2025-07-09T07:01:47.497-07:00",
        "team_id": 58,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "cfd5c444-ef4b-4bc2-a8e9-856fde3b187c",
      "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": "9c2d4015-ba7a-40c7-a823-a43d5ad4358a",
        "slack_channel_ids": [
          "6db5c592-f4c1-5e87-962e-6415d79f8aeb"
        ],
        "created_at": "2025-07-09T07:01:46.366-07:00",
        "updated_at": "2025-07-09T07:01:46.366-07:00",
        "team_id": 58,
        "communication_group_members": [
          {
            "id": "6ccc04ec-0c70-4b86-b98f-1a0672a0a458",
            "user_id": 63,
            "name": "Charisse Larson",
            "email": "yvone.wuckert@mraz.example"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "fe7959e4-9461-4694-80c4-5c5dde1372b6",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "019a0d63-eb61-4fa4-bf29-6c57b75971c6",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "42d74fa4-7cec-4946-b830-4a182adce7b2",
                "name": "Aut temporibus itaque quis."
              }
            ]
          }
        ]
      }
    }
  ],
  "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

The response is of type object.