Skip to content
Get Started

Groups

Operations for group messaging (beta)

Get group membership
GET/api/v2/groups/{group_id}
ModelsExpand Collapse
GroupRetrieveResponse object { data, status }
data: optional object { created_at, group_id, group_name, 6 more }
created_at: optional string
group_id: optional string
group_name: optional string
latest_comm_at: optional string
latest_message_id: optional string
participant_numbers: optional array of string

Convenience list of resolved participant phone numbers. Participants with email-only handles remain in participants but are omitted here.

participants: optional array of object { contact_id, handle, name, 4 more }
contact_id: optional string

Contact ID when this participant is linked to a contact

handle: optional string

Raw participant handle, usually an E.164 phone number but sometimes an iMessage email handle

name: optional string

Contact or seat display name when available

participant_id: optional string

Unique participant row identifier

phone: optional string

Resolved participant phone number, preferring the stored group phone handle and falling back to contact phone. Email handles remain available in handle.

seat_id: optional string

Seat ID when this participant is a team member

type: optional "contact" or "seat"

Participant kind

One of the following:
"contact"
"seat"
updated_at: optional string
worker_group_id: optional string

Worker-local iMessage group identifier when known

status: optional string