GET
/
v1
/
communications
/
groups
Lists communications groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "a815def0-ddc4-417f-89f7-364c024b8359",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:15.236-07:00",
        "updated_at": "2025-09-08T17:05:15.236-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "c1492267-50ca-40b2-bc45-5111608faae9",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:14.289-07:00",
        "updated_at": "2025-09-08T17:05:14.289-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "901ec411-3992-464e-a780-61b6b4e2c5c8",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:13.362-07:00",
        "updated_at": "2025-09-08T17:05:13.362-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "8fe66dd6-cbd2-4b6c-b9e2-79cf26a4bfea",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:12.425-07:00",
        "updated_at": "2025-09-08T17:05:12.425-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "9dc3daf2-d79a-4442-a1fb-4d351626a77c",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:10.937-07:00",
        "updated_at": "2025-09-08T17:05:10.937-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "25296758-43b0-434e-bc0d-fa6fdda67804",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:09.930-07:00",
        "updated_at": "2025-09-08T17:05:09.930-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "b0d0df11-a10d-4491-9f00-4b41321b232b",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:08.957-07:00",
        "updated_at": "2025-09-08T17:05:08.957-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "ea95cd1a-b8ca-4f09-8e41-547009736259",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:07.943-07:00",
        "updated_at": "2025-09-08T17:05:07.943-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "0172b31a-0fb0-4990-a6eb-a732507d4f47",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [],
        "created_at": "2025-09-08T17:05:07.039-07:00",
        "updated_at": "2025-09-08T17:05:07.039-07:00",
        "team_id": 65,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "66906ef2-5b40-4923-b304-edc9dc44a689",
      "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": "b9cfc3e9-0cae-4411-8a92-ebcd557a8408",
        "slack_channel_ids": [
          "f132f206-a091-5e36-babd-b45626e12fc9"
        ],
        "created_at": "2025-09-08T17:05:06.008-07:00",
        "updated_at": "2025-09-08T17:05:06.008-07:00",
        "team_id": 65,
        "communication_group_members": [
          {
            "id": "51ac47a5-d3e7-45b5-a2ec-f2fd1ebf3a64",
            "user_id": 80,
            "name": "Brice Stoltenberg",
            "email": "yen.abernathy@hirthe-volkman.test"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "31014669-d3d3-443a-9fee-afe0d97613b6",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "6de3a252-c574-463d-8833-84c66609408d",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "9fdbd1bf-5657-4d90-8af0-cf52802dbd9b",
                "name": "Tempora et deserunt modi."
              }
            ]
          }
        ]
      }
    }
  ],
  "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[search]
string
​
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.