Skip to main content
POST
imessage.group.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by imessage.group.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

participants
string[]
required

Current group participant addresses.

Phone number including country code, or an email address.

Maximum string length: 320
name
string

Group display name.

channel
enum<string>

The actual messaging channel.

Available options:
imessage,
sms,
rcs,
whatsapp
createdAt
string

Creation timestamp, ISO 8601 UTC.

photo
object

Group photo copied into your private file storage.