> ## Documentation Index
> Fetch the complete documentation index at: https://docs.periskope.app/llms.txt
> Use this file to discover all available pages before exploring further.

# The Chat Object

> A WhatsApp chat (1-1 conversation or group) synced into the workspace, together with its Periskope attributes (labels, assignee, custom properties, status).

```json The Chat Object theme={null}
{
  "org_id": "00000000-0000-0000-0000-000000000000",
  "chat_id": "120363000000000000@g.us",
  "org_phone": "911111111111@c.us",
  "chat_name": "Example Group",
  "chat_type": "group",
  "chat_image": "https://example.com/images/example.jpg",
  "invite_link": "https://chat.whatsapp.com/invite/AAAAAAAAAAAAAAAAAAAAAA",
  "label_ids": {
    "label-aaaaaaaaaaaaaaaa": true
  },
  "labels": [
    "priority"
  ],
  "custom_properties": {
    "Custom Property": "Value"
  },
  "assigned_to": "user@example.com",
  "chat_access": {
    "user@example.com": true
  },
  "group_description": "A sample group description",
  "info_admins_only": false,
  "messages_admins_only": false,
  "add_members_admins_only": false,
  "member_count": 12,
  "members": {
    "key": {
      "org_id": "00000000-0000-0000-0000-000000000000",
      "chat_id": "120363000000000000@g.us",
      "org_phone": "911111111111@c.us",
      "contact_id": "922222222222@c.us",
      "contact_name": "John Doe",
      "contact_image": "https://example.com/images/example.jpg",
      "contact_color": "#000000",
      "is_admin": false,
      "is_super_admin": false,
      "is_internal": false
    }
  },
  "latest_message": {
    "message_id": "true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "org_phone": "911111111111@c.us",
    "chat_id": "120363000000000000@g.us",
    "body": "Hello! This is a sample message.",
    "message_type": "chat",
    "from_me": true,
    "author": "922222222222@c.us",
    "ack": "4",
    "timestamp": "2026-01-15T09:30:00+00:00",
    "media": {
      "path": "https://example.com/images/example.jpg",
      "mimetype": "image/png",
      "filename": "image.png"
    },
    "mentioned_ids": [
      "922222222222@c.us"
    ],
    "performed_by": "api",
    "quoted_message_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "sender_phone": "911111111111@c.us",
    "sent_message_id": "00000000-0000-0000-0000-000000000000",
    "delivery_info": {
      "delivered": {
        "key": null
      },
      "read": {
        "key": null
      },
      "pending": [
        null
      ],
      "read_count": null,
      "delivered_count": null
    },
    "is_deleted": null,
    "is_forwarded": null,
    "is_starred": null,
    "has_media": null,
    "unique_id": "AAAAAAAAAAAAAAAAAAAAAA",
    "updated_at": "2026-01-15T09:31:12.884+00:00"
  },
  "latest_message_timestamp": "2026-01-15T09:30:00+00:00",
  "message_unread_count": 0,
  "flag_count_map": {
    "key": null
  },
  "parent_community_id": null,
  "is_archived": false,
  "group_metadata": {},
  "is_muted": false,
  "is_exited": false,
  "closed_at": null,
  "created_at": "2026-01-10T08:00:00+00:00",
  "updated_at": "2026-01-15T09:30:00.025233+00:00"
}
```

**Attributes**

**org\_id** `string`

The unique identifier of the organization that owns the WhatsApp account.

**chat\_id** `string`

The unique identifier of the WhatsApp chat (format: \{phone\_number}@c.us for individual chats or \{group\_id}@g.us for groups).

**org\_phone** `string`

The organization phone that the chat belongs to (in the format \{phone\_number}@c.us).

**chat\_name** `string`

The display name of the chat. For groups, this is the group name. For individual chats, this is the contact's name.

**chat\_type** `string`

The type of chat. Can be `group`, `user`, or `business`.

**chat\_image** `string`

The URL of the chat's profile image.

**invite\_link** `string`

The invite link of the chat. Group chats only, and only when the phone is an admin.

**label\_ids** `object`

A map of label identifiers associated with the chat, where keys are label IDs and values are booleans.

**labels** `string[]`

An array of labels associated with the chat.

**custom\_properties** `object`

A map of custom properties associated with the chat. Values depend on the property type: dropdown, text, date.

**assigned\_to** `string`

The email address of the user assigned to this chat. Absent when unassigned.

**chat\_access** `object`

A map of user access permissions, where keys are email addresses and values are booleans. Absent when no per-chat overrides exist.

**group\_description** `string`

The description text for group chats. Group chats only.

**info\_admins\_only** `boolean`

Indicates if only admins can modify group info.

**messages\_admins\_only** `boolean`

Indicates if only admins can send messages in the group.

**add\_members\_admins\_only** `boolean`

Indicates if only admins can add new members to the group.

**member\_count** `integer`

The total number of participants in the chat.

**members** `object`

A map of members in the chat, keyed by WhatsApp ID (format: \{phone\_number}@c.us). Only returned when fetching a single chat by id — list results omit it.

**each value**

**org\_id** `string`

The unique identifier of the organization that owns the WhatsApp account.

**chat\_id** `string`

The unique identifier of the WhatsApp chat.

**org\_phone** `string`

The WhatsApp ID of the organization's account (format: \{phone\_number}@c.us).

**contact\_id** `string`

The WhatsApp ID of the member (format: \{phone\_number}@c.us).

**contact\_name** `string`

The display name of the member.

**contact\_image** `string`

The URL of the member's profile image.

**contact\_color** `string`

The hex color code assigned to the member in Periskope's UI.

**is\_admin** `boolean`

Indicates if the member has admin privileges in the chat.

**is\_super\_admin** `boolean`

Indicates if the member has super admin privileges in the chat.

**is\_internal** `boolean`

Indicates if the member is an internal user of the organization.

**latest\_message** `object`

An object containing details about the latest message sent in the chat.

**properties**

**message\_id** `string`

Unique id of the message, in the form \<from\_me>*\<chat\_id>*\<wa\_message\_id>

**org\_id** `string`

Id of the organization the message belongs to

**org\_phone** `string`

Org phone (WhatsApp account) the message was sent or received on, as country code + number suffixed with @c.us

**chat\_id** `string`

Chat the message belongs to — \<countrycode>\<number>@c.us for 1-1 chats, \<group-id>@g.us for group chats

**body** `string`

Text content of the message, or the caption of a media message.

**message\_type** `string`

Content type of the message: 'chat' for text, otherwise the media/attachment type (e.g. 'image', 'video', 'document', 'audio', 'ptt', 'sticker', 'location', 'poll\_creation')

**from\_me** `boolean`

true when the message was sent by the org phone, false when it was received from the contact

**author** `string`

In group chats, the participant who sent the message (\<countrycode>\<number>@c.us).

**ack** `string`

WhatsApp acknowledgement level of an outgoing message as a string: '1' sent, '2' delivered, '3' read, '4' played/read.

**timestamp** `string`

When the message was sent, as an ISO 8601 UTC timestamp

**media** `object`

Media attached to the message (may also carry dimensions, size, thumbnail).

**properties**

**path** `string`

URL of the media file

**mimetype** `string`

MIME type of the media file

**filename** `string`

Filename of the media file, when applicable

**mentioned\_ids** `string[]`

Contact ids @-mentioned in the message body.

**performed\_by** `string`

Member email or "api" when the message was sent through Periskope.

**quoted\_message\_id** `string`

message\_id of the message this message replies to. Absent when the message is not a reply.

**sender\_phone** `string`

Phone that sent the message, as country code + number suffixed with @c.us

**sent\_message\_id** `string`

Internal id assigned when the message was sent via the Periskope queue. Absent for received messages.

**delivery\_info** `object`

Per-recipient delivery and read receipts of an outgoing message.

**properties**

**delivered** `object`

Map of recipient contact\_id to delivery epoch-ms timestamp

**read** `object`

Map of recipient contact\_id to read epoch-ms timestamp

**pending** `string[]`

Recipients the message has not been delivered to yet

**read\_count** `number`

Number of recipients who have read the message

**delivered\_count** `number`

Number of recipients the message was delivered to

**is\_deleted** `boolean`

true when the message was deleted for everyone.

**is\_forwarded** `boolean`

true when the message was forwarded.

**is\_starred** `boolean`

true when the message is starred.

**has\_media** `boolean`

true when the message carries media.

**unique\_id** `string`

WhatsApp message id without the from\_me/chat\_id prefix — accepted by message endpoints in place of the full message\_id

**updated\_at** `string`

When the message record was last updated (e.g. by a delivery receipt), as an ISO 8601 UTC timestamp

**latest\_message\_timestamp** `string`

Timestamp of the most recent message in the chat, as an ISO 8601 UTC timestamp.

**message\_unread\_count** `integer`

The number of unread messages in the chat.

**flag\_count\_map** `object`

A map of flagged messages, where keys are phone numbers and values are flagged messages count.

**parent\_community\_id** `string`

Indicates the id of the parent community for the group.

**is\_archived** `boolean`

Indicates if the chat has been archived.

**group\_metadata** `object`

Additional raw group metadata synced from WhatsApp, when present

**is\_muted** `boolean`

Indicates if notifications for this chat are muted.

**is\_exited** `boolean`

Indicates if the organization has left this chat.

**closed\_at** `number`

The timestamp when the chat was closed, if applicable, as an epoch timestamp in milliseconds. Absent while the chat is open.

**created\_at** `string`

The ISO 8601 formatted timestamp when the chat was created.

**updated\_at** `string`

The ISO 8601 formatted timestamp when the chat was last updated.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.