string
Id of the organization the contact belongs to
string
Unique id of the contact within the org: country code + number suffixed with @c.us. Use the number part (with or without the suffix) wherever a contact_id parameter is expected.
string
Display name of the contact — the Periskope-set name when one was saved via the API or dashboard, otherwise the WhatsApp verified name, address-book name or push name. null when no name is known from any source.
string
WhatsApp username of the contact. null when the contact has not set one or it has not been synced yet.
string
Type of the WhatsApp account: ‘user’ for a personal account, ‘business’ for a business account. null when not yet synced.
boolean
Whether the number is registered on WhatsApp, as reported by the connected phone. null when not yet synced.
boolean
Whether the contact is saved in the connected phone’s address book. null when not yet synced.
boolean
Whether the contact is marked as internal (e.g. a teammate). Messages from internal contacts are not flagged for response. null when the flag was never set.
boolean
true when the contact was created via the API or an import rather than synced from a phone. null for synced contacts.
string
URL of the contact’s WhatsApp profile picture. null when the contact has no picture or it is not accessible.
string
Hex color assigned to the contact, used to render it in the dashboard. null when no color is assigned.
object
Map of label_id to boolean for the labels on the contact. Labels on a contact are shared with its 1-1 chat. An empty object when the contact has no labels.
string[]
Names of the labels currently on the contact, resolved from label_ids
string[]
Ids of the chats the contact participates in — the 1-1 chat (<countrycode><number>@c.us) and any group chats (<group-id>@g.us) shared with the workspace. Contains a single null entry when the contact is not a participant of any chat.
string
When the contact record was last updated, as an ISO 8601 timestamp