Retrieve Messaging Group

Beta

GET/v1/messaging/groups/{id}

This endpoint is idempotent. Learn more

Retrieves a reusable roster together with its current 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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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.

This identifies the member's place on the roster, not the user or agent themselves; it is the id to pass when removing them 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

The role the actor holds in the account, which determines what it is permitted to do.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles are custom to your 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 {permission}:{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 OpenMRP from '@openmrp/sdk';

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

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

console.log(messagingGroup.id);

import OpenMRP from '@openmrp/sdk';

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

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

console.log(messagingGroup.id);

200 example

{
  "id": "cvgp_wjlypugna7s4",
  "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_obu4df48t1xx",
        "object": "messaging_group_member",
        "actor": {
          "id": "acus_e5zu8bde0z3h",
          "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_wjlypugna7s4",
  "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_obu4df48t1xx",
        "object": "messaging_group_member",
        "actor": {
          "id": "acus_e5zu8bde0z3h",
          "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