Groupsv4

Get a group

GET/groups/{groupId}

A group id that was merged into another group on its first send (see Create a group) returns the surviving group. Compare the returned id with the one you asked for to pick up the canonical id.

Path parameters

groupIdRequiredstring

Unique identifier of the group, prefixed with grp_. Returned by the List groups endpoint.

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Returns

dataoptionalGroup
idoptionalstring

Group id (grp_...).

channel_idoptionalstring
channel_typeoptionalstring
"blooio""twilio""whatsapp""whatsapp_business""rcs_business""amb""sms""voice"
nameoptionalstring | null
icon_urloptionalstring | null
chat_idoptionalstring | null
chat_linkedoptionalboolean

Whether the group has an iMessage conversation on at least one of your numbers. false until the first message to the group opens one.

created_atoptionalinteger
membersoptionalGroupMember[]

Array of GroupMember

identity_idoptionalstring
contact_idoptionalstring | null
roleoptionalstring
channel_typeoptionalstring
"blooio""twilio""whatsapp""whatsapp_business""rcs_business""amb""sms""voice"
identifieroptionalstring
nameoptionalstring | null

The member's contact name. null when none is on file.

Response codes

200A group
401Your API key is missing or invalid. Pass it as a bearer token.
404No group was found with the provided `groupId`.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X GET https://api.blooio.com/v4/groups/grp_a1b2c3d4 \
Response objectexample
{  "data": {    "id": "grp_a1b2c3d4",    "channel_id": "ch_a1b2c3d4",    "channel_type": "blooio",    "name": "Jane Doe",    "icon_url": "https://example.com",    "chat_id": "chat_a1b2c3d4",    "chat_linked": false,    "created_at": 0,    "members": [      {        "identity_id": "idn_a1b2c3d4",        "contact_id": "ct_a1b2c3d4",        "role": "string",        "channel_type": "blooio",        "identifier": "+15551234567",        "name": "Jane Doe"      }    ]  }}