GET
/
v1
/
communications
/
groups
Lists communications groups
curl --request GET \
  --url https://api.rootly.com/v1/communications/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "05289a0f-053c-43bf-aece-38da63268559",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:55.253-07:00",
        "updated_at": "2025-08-19T10:18:55.253-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "2ce18cbf-cfb7-4c6f-9806-82687afb9a1c",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:53.199-07:00",
        "updated_at": "2025-08-19T10:18:53.199-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "8f66b164-f9e4-4e51-bf42-7cad08576304",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:52.020-07:00",
        "updated_at": "2025-08-19T10:18:52.020-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "e2c5d86a-3c73-4d4c-8a04-14d7eaa2567a",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:50.887-07:00",
        "updated_at": "2025-08-19T10:18:50.887-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "bcfc4d15-8e34-441d-9861-8dbeb2856e76",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:49.856-07:00",
        "updated_at": "2025-08-19T10:18:49.856-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "b9415d09-e8f0-4645-8260-c38c73aea594",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:48.708-07:00",
        "updated_at": "2025-08-19T10:18:48.708-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "98ef86ce-0109-485f-8fab-547541c39eb5",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:47.665-07:00",
        "updated_at": "2025-08-19T10:18:47.665-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "8360d6a0-0f31-4dcb-af6f-6f82b2e5acb6",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:46.545-07:00",
        "updated_at": "2025-08-19T10:18:46.545-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "33bc5b76-75c9-423b-aaf2-0baecf9a7df2",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [],
        "created_at": "2025-08-19T10:18:45.493-07:00",
        "updated_at": "2025-08-19T10:18:45.493-07:00",
        "team_id": 59,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "b3285d56-edcf-4cdc-bb76-619279302e90",
      "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": "2b17af4d-be66-4635-9e87-1b81aa7d987e",
        "slack_channel_ids": [
          "05a59b5c-e20e-51c0-9df0-f9a8b6838658"
        ],
        "created_at": "2025-08-19T10:18:44.514-07:00",
        "updated_at": "2025-08-19T10:18:44.514-07:00",
        "team_id": 59,
        "communication_group_members": [
          {
            "id": "ddb4b094-53a7-4bad-9ac7-3c22d75c52ce",
            "user_id": 64,
            "name": "Eduardo Kessler",
            "email": "patrick@harvey-schuppe.example"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "b6f9dae8-96c2-41b9-8e44-3e032229a4a6",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "36737cf2-1817-4012-a57b-d6aa1bd0dcd4",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "fa0517fb-e6f6-4c73-840e-d4345ffd9bda",
                "name": "Enim consequuntur et 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.