Skip to content

Get group membership

GET/api/v2/groups/{group_id}

Retrieve the current complete membership for a group owned by the authenticated account.

Path ParametersExpand Collapse

group_id: string

Modern sb_group_* identifiers and legacy group_id identifiers are supported.

maxLength160

ReturnsExpand Collapse

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

Get group membership

curl https://api.sendblue.co/api/v2/groups/$GROUP_ID \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"

{
  "data": {
    "created_at": "2026-07-22T07:46:50.063Z",
    "group_id": "sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455",
    "group_name": "+15167251294, +13472604672, +12138578327",
    "latest_comm_at": "2026-07-22T07:46:50.455Z",
    "latest_message_id": "FFEBE7AA-C6DF-4645-ACDB-CF796AA94C5E",
    "participant_numbers": [
      "+15167251294",
      "+13472604672",
      "+12138578327"
    ],
    "participants": [
      {
        "contact_id": "b76884a0-91ae-4568-a96d-a0d36e389276",
        "handle": "+15167251294",
        "name": "Jane Doe",
        "participant_id": "28460d34-8867-4c97-abf3-bb3b6a1fdd6f",
        "phone": "+15167251294",
        "seat_id": null,
        "type": "contact"
      }
    ],
    "updated_at": "2026-07-22T07:46:50.170Z",
    "worker_group_id": "82F8AE6E-ED4F-4FEA-83D3-AF3786E6186E"
  },
  "status": "OK"
}

Returns Examples

{
  "data": {
    "created_at": "2026-07-22T07:46:50.063Z",
    "group_id": "sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455",
    "group_name": "+15167251294, +13472604672, +12138578327",
    "latest_comm_at": "2026-07-22T07:46:50.455Z",
    "latest_message_id": "FFEBE7AA-C6DF-4645-ACDB-CF796AA94C5E",
    "participant_numbers": [
      "+15167251294",
      "+13472604672",
      "+12138578327"
    ],
    "participants": [
      {
        "contact_id": "b76884a0-91ae-4568-a96d-a0d36e389276",
        "handle": "+15167251294",
        "name": "Jane Doe",
        "participant_id": "28460d34-8867-4c97-abf3-bb3b6a1fdd6f",
        "phone": "+15167251294",
        "seat_id": null,
        "type": "contact"
      }
    ],
    "updated_at": "2026-07-22T07:46:50.170Z",
    "worker_group_id": "82F8AE6E-ED4F-4FEA-83D3-AF3786E6186E"
  },
  "status": "OK"
}