Retrieve Messaging Group

Beta

GET/v1/messaging/groups/{id}

This endpoint is idempotent. Learn more

Retrieves a reusable roster (with its members).

Permissions requiredValues:messaging:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Messaging group ID.

idstring

Messaging group ID.

objectstringenumValues:messaging_group

Resource type identifier.

namestring

The roster's display name.

memberslistnullable

The roster's members (users and agents).

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of messaging_group_member

Resources in this page.

idstring

Membership ID (used to remove the member from the roster).

objectstringenumValues:messaging_group_member

Resource type identifier.

actoractornullable

The member: a user (account user) or an agent.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Retrieve Messaging Group

Retrieve Messaging Group

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const messagingGroup = await client.messaging.groups.retrieve('cvgp_018e88072d1320808dc97abc');

console.log(messagingGroup.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const messagingGroup = await client.messaging.groups.retrieve('cvgp_018e88072d1320808dc97abc');

console.log(messagingGroup.id);

200 example

{
  "id": "cvgp_018e88072d1320808dc97abc",
  "object": "messaging_group",
  "name": "Operations Team",
  "members": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "cvgppt_018e88072d1320808dc9def",
        "object": "messaging_group_member",
        "actor": {
          "id": "acus_01ea9983ddb41dacc44ecf997c",
          "object": "actor",
          "type": "user",
          "name": "Jie Yan",
          "handle": null,
          "avatar_url": null,
          "role": null
        }
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "cvgp_018e88072d1320808dc97abc",
  "object": "messaging_group",
  "name": "Operations Team",
  "members": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "cvgppt_018e88072d1320808dc9def",
        "object": "messaging_group_member",
        "actor": {
          "id": "acus_01ea9983ddb41dacc44ecf997c",
          "object": "actor",
          "type": "user",
          "name": "Jie Yan",
          "handle": null,
          "avatar_url": null,
          "role": null
        }
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Messaging Group

Authorization

Path Parameters

Returns

Responses