Skip to main content
GET
Preferences

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

id
string
required

Response

Success

contactId
string
required
preferredChannel
enum<string> | null
required
Available options:
email,
sms,
whatsapp,
phone,
post
doNotContact
boolean
required
doNotContactReason
string | null
required
doNotContactSource
string | null
required
doNotContactAt
string | null
required
doNotContactBy
object
required
permissions
object[]
required
revision
required
updatedAt
string | null
required