---
title: "Returns contact groups"
method: GET
path: "/v1/directory/{directorySelector}/contact_groups"
tags: ["directory"]
---

# Returns contact groups

`GET /v1/directory/{directorySelector}/contact_groups`

## Path parameters

- `directorySelector` string, required

## Query parameters

- `query` string
- `search` string
- `sort` string
- `page` integer
- `size` integer

## Response `200`

OK

- ContactGroupResponse[]
  - `name` string, required — group name
  - `remarks` string — custom remarks
  - `birthdayTemplateId` integer — message template used for birthday messages
  - `remoteSmsEnabled` boolean — remote SMS enabled?
  - `remoteSmsShortcut` string — remote SMS shortcut
  - `remoteSmsTemplateId` integer — message template used for remote SMS
  - `welcomeSmsContent` string — welcome sms content
  - `welcomeSmsActive` boolean — welcome sms active?
  - `goodbyeSmsContent` string — goodbye sms content
  - `goodbyeSmsActive` boolean — goodbye sms active?
  - `welcomeWhatsappContent` string — welcome whatsapp content
  - `welcomeWhatsappActive` boolean — welcome whatsapp active?
  - `goodbyeWhatsappContent` string — goodbye whatsapp content
  - `goodbyeWhatsappActive` boolean — goodbye whatsapp active?
  - `mobile` boolean — is sms/voice/push group?
  - `whatsapp` boolean — is whatsapp group?
  - `rcs` boolean — is rcs group?
  - `id` integer, required — contact group id
  - `size` integer — size of group
  - `whatsappSize` integer — amount of whatsapp recipients in group
  - `mobileSize` integer — amount of mobile (having msisdn set) recipients in group
  - `mobileChannelEnabledSize` integer — amount of recipients in group with enabled mobile channels
  - `whatsappChannelEnabledSize` integer — amount of recipients in group with enabled whatsapp channels
  - `rcsChannelEnabledSize` integer — amount of recipients in group with enabled rcs channels
  - `allChannelsEnabledSize` integer — amount of recipients in group with enabled mobile AND whatsapp channel
  - `whatsappChannelAndWhatsappDeviceEnabledSize` integer — amount of recipients in group with whatsapp AND enabled whatsapp channel AND whatsapp device
  - `mobileAndMobileChannelEnabledSize` integer — amount of recipients in group with enabled mobile channels and mobile
  - `mobileAndRcsChannelEnabledSize` integer — amount of recipients in group with enabled rcs channels and mobile (msisdn field)
  - `mobileAndWhatsappChannelEnabledSize` integer — amount of recipients in group with enabled rcs channels and mobile (msisdn field)
  - `whatsappAndWhatsappChannelEnabledSize` integer — amount of recipients in group with enabled whatsapp channels and whatsapp
  - `allChannelsEnabledAndReachableSize` integer — amount of recipients in group with enabled mobile AND whatsapp channel AND mobile AND whatsapp AND whatsapp device
  - `allChannelsEnabledAndRecipientsSize` integer — amount of recipients in group with all channels enabled and non empty recipients
  - `emailAddressSize` integer — amount of recipients in group containing emailAddress
  - `lastTransfer` string, date-time — last transfer
  - `lastModified` string, date-time — last modified
  - `lastModifiedBy` string — last modified by
  - `links` Link[] — links
    - `rel` string
    - `href` string
  - `birthdayTemplate` MessageTemplateResponse
    - `name` string, required — message template name
    - `content` string, required — message template content
    - `sender` string — sender
    - `deliveryReport` boolean, required — request delivery report?
    - `remoteSmsShortcut` string — remote SMS shortcut
    - `smsType` integer — SMS type (0 = default, 1 = flash, 2 = both)
    - `contentCategory` string — content category (personal, advertisement or informational
    - `messageType` string — message type (default, voice, whatsapp, rcs
    - `urlshorteningType` string — urlshortening type
    - `pinned` boolean — pinned?
    - `templateCategoryId` integer — template category id
    - `preselectedCustomerChannelId` integer — preselected customer channel id
    - `rcsMessage` RcsMessage
      - `agentMessage` AgentContentMessageDto, required
        - `text` string
        - `fileName` string
        - `richCard` RichCardDto
          - `carouselCard` CarouselCardDto
            - `cardWidth` string
            - `cardContents` CardContentDto[]
              - …
          - `standaloneCard` StandaloneCardDto
            - `cardOrientation` string
            - `thumbnailImageAlignment` string
            - `cardContent` CardContentDto
              - …
        - `suggestions` SuggestionDto[]
          - `reply` ReplyDto
            - `text` string
            - `postbackData` string
          - `action` ActionDto
            - `text` string
            - `postbackData` string
            - `dialAction` DialActionDto
              - …
            - `viewLocationAction` ViewLocationActionDto
              - …
            - `createCalendarEventAction` CreateCalendarEventActionDto
              - …
            - `openUrlAction` OpenUrlActionDto
              - …
            - `shareLocationAction` ShareLocationActionDto
            - `composeAction` ComposeActionDto
              - …
        - `contentInfo` ContentInfoDto
          - `fileUrl` string
          - `thumbnailUrl` string
          - `forceRefresh` boolean
    - `id` integer, required — message template id
    - `lastModified` string, date-time — last modified
    - `lastModifiedBy` string — last modified by
    - `usageCounter` integer — usage counter
    - `links` Link[] — links
      - `rel` string
      - `href` string
  - `remoteSmsTemplate` MessageTemplateResponse
    - `name` string, required — message template name
    - `content` string, required — message template content
    - `sender` string — sender
    - `deliveryReport` boolean, required — request delivery report?
    - `remoteSmsShortcut` string — remote SMS shortcut
    - `smsType` integer — SMS type (0 = default, 1 = flash, 2 = both)
    - `contentCategory` string — content category (personal, advertisement or informational
    - `messageType` string — message type (default, voice, whatsapp, rcs
    - `urlshorteningType` string — urlshortening type
    - `pinned` boolean — pinned?
    - `templateCategoryId` integer — template category id
    - `preselectedCustomerChannelId` integer — preselected customer channel id
    - `rcsMessage` RcsMessage
      - `agentMessage` AgentContentMessageDto, required
        - `text` string
        - `fileName` string
        - `richCard` RichCardDto
          - `carouselCard` CarouselCardDto
            - `cardWidth` string
            - `cardContents` CardContentDto[]
              - …
          - `standaloneCard` StandaloneCardDto
            - `cardOrientation` string
            - `thumbnailImageAlignment` string
            - `cardContent` CardContentDto
              - …
        - `suggestions` SuggestionDto[]
          - `reply` ReplyDto
            - `text` string
            - `postbackData` string
          - `action` ActionDto
            - `text` string
            - `postbackData` string
            - `dialAction` DialActionDto
              - …
            - `viewLocationAction` ViewLocationActionDto
              - …
            - `createCalendarEventAction` CreateCalendarEventActionDto
              - …
            - `openUrlAction` OpenUrlActionDto
              - …
            - `shareLocationAction` ShareLocationActionDto
            - `composeAction` ComposeActionDto
              - …
        - `contentInfo` ContentInfoDto
          - `fileUrl` string
          - `thumbnailUrl` string
          - `forceRefresh` boolean
    - `id` integer, required — message template id
    - `lastModified` string, date-time — last modified
    - `lastModifiedBy` string — last modified by
    - `usageCounter` integer — usage counter
    - `links` Link[] — links
      - `rel` string
      - `href` string

## Other responses

- `400` — Bad request
- `500` — Internal server error

---

[API](https://skmtc.dev/linkmobility/apis/untitled-api.md) · [All operations](https://skmtc.dev/linkmobility/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/linkmobility/untitled-api/revisions/db84f79799b9/schema)