GET
/
v1
/
communications
/
groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "05fa3162-ecb3-4341-933b-25924552a9ca",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:06.250-07:00",
        "updated_at": "2025-06-18T16:02:06.250-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "38275806-1c71-429f-8b23-e35ba6f180d7",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:05.435-07:00",
        "updated_at": "2025-06-18T16:02:05.435-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "08878766-c178-4e47-b5d6-4fd9595a902b",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:04.676-07:00",
        "updated_at": "2025-06-18T16:02:04.676-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "64215294-8f92-482a-bedd-920e551fb71c",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:03.814-07:00",
        "updated_at": "2025-06-18T16:02:03.814-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "4d843058-759c-475b-8702-ae62843d93ef",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:03.030-07:00",
        "updated_at": "2025-06-18T16:02:03.030-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "084ed9ba-693a-4d64-91a2-c606ec97905d",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:02.191-07:00",
        "updated_at": "2025-06-18T16:02:02.191-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "0221c895-46ee-4e6a-b8fe-308b315a93ce",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:02:01.315-07:00",
        "updated_at": "2025-06-18T16:02:01.315-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "9c4def4e-b2a9-4da1-87e9-48ab0c500cc7",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:01:59.912-07:00",
        "updated_at": "2025-06-18T16:01:59.912-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "20a3cb44-1e6e-4a90-aea9-91dd9cf4c664",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [],
        "created_at": "2025-06-18T16:01:58.947-07:00",
        "updated_at": "2025-06-18T16:01:58.947-07:00",
        "team_id": 61,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "5336f019-94df-4ba0-8ca5-a50c29b4c98f",
      "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": "ef9fe886-1ba2-4913-8ee3-59f32c5630ed",
        "slack_channel_ids": [
          "93501ed1-199d-56dc-90bc-64edc961ced0"
        ],
        "created_at": "2025-06-18T16:01:58.056-07:00",
        "updated_at": "2025-06-18T16:01:58.056-07:00",
        "team_id": 61,
        "communication_group_members": [
          {
            "id": "7004687e-cc94-4c1d-96d1-8fd6e8d5e512",
            "user_id": 63,
            "name": "Ethan Gibson",
            "email": "tom_bailey@kovacek.example"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "7f72e948-4679-4168-93d4-b2274eef9e8c",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "50f2f04c-1145-4017-95b8-8ab7c4623601",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "3d125b7a-e570-4a39-bac7-fbf771b0d04c",
                "name": "Debitis est commodi molestiae."
              }
            ]
          }
        ]
      }
    }
  ],
  "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.