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": "b99eb127-10e9-49ef-8825-befe5eaabd60",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:28.550-08:00",
        "updated_at": "2025-11-06T13:20:28.550-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "848f3b9d-2941-4c1e-9a4a-1d0396655560",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:27.155-08:00",
        "updated_at": "2025-11-06T13:20:27.155-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "4f5d6b88-d2ff-4234-b9e6-f68d6924089a",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:25.607-08:00",
        "updated_at": "2025-11-06T13:20:25.607-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "5b42d981-8055-49b1-976f-b2f93a2c4d24",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:24.136-08:00",
        "updated_at": "2025-11-06T13:20:24.136-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "715eab4d-daa3-4018-9ecb-9d07bc1e91b8",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:22.557-08:00",
        "updated_at": "2025-11-06T13:20:22.557-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "22b146e3-763a-45f6-ab40-eebf3a30a3aa",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:20.621-08:00",
        "updated_at": "2025-11-06T13:20:20.621-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "8b2407c6-bdcc-45be-b892-41019fa8643f",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:18.379-08:00",
        "updated_at": "2025-11-06T13:20:18.379-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "a5e69d02-8157-4741-90af-dd7ebbac792e",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:16.892-08:00",
        "updated_at": "2025-11-06T13:20:16.892-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "a2b3f1ee-e0d3-448d-aef9-308987963d99",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [],
        "created_at": "2025-11-06T13:20:15.183-08:00",
        "updated_at": "2025-11-06T13:20:15.183-08:00",
        "team_id": 108,
        "communication_group_members": [],
        "communication_external_group_members": [],
        "communication_group_conditions": []
      }
    },
    {
      "id": "e039adc9-fa9c-45e9-823f-e83bba88c0a1",
      "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": "ca09e9d0-5f3c-4971-8dc8-77555384c268",
        "slack_channel_ids": [
          "760ee423-372c-5db1-be7b-2fd10e10317b"
        ],
        "created_at": "2025-11-06T13:20:13.767-08:00",
        "updated_at": "2025-11-06T13:20:13.767-08:00",
        "team_id": 108,
        "communication_group_members": [
          {
            "id": "ef7b028d-9432-4d95-9423-e1bcd421e7e2",
            "user_id": 107,
            "name": "Monty Nikolaus",
            "email": "fredric.sporer@gislason.example"
          }
        ],
        "communication_external_group_members": [
          {
            "id": "18dc66f9-6be4-4b4e-bd0c-340af83425da",
            "name": "External member",
            "email": "external@example.com",
            "phone_number": "+911234567890"
          }
        ],
        "communication_group_conditions": [
          {
            "id": "7bc8112b-6f25-40a4-9bb8-b79845a1b195",
            "condition": "is",
            "property_type": "service",
            "properties": [
              {
                "id": "9dd88c4e-335e-421e-9684-d111c4247620",
                "name": "Autem possimus eligendi necessitatibus."
              }
            ]
          }
        ]
      }
    }
  ],
  "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