> ## 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 Ticket Info Object

> A ticket together with its chat, the message it was raised from and (on GET /tickets/{ticket_id}) the messages attached to it.

```json The Ticket Info Object theme={null}
{
  "chat": {
    "org_id": "00000000-0000-0000-0000-000000000000",
    "chat_id": "120363000000000000@g.us",
    "members": {
      "key": {
        "contact_id": "911111111111@c.us",
        "chat_id": "120363000000000000@g.us",
        "org_id": "00000000-0000-0000-0000-000000000000",
        "org_phone": "911111111111@c.us",
        "is_admin": false,
        "is_super_admin": false,
        "contact_name": "Rahul Sharma",
        "contact_image": "https://example.com/files/image.png",
        "contact_color": "#7D9EF1",
        "is_internal": false,
        "contact_labels": "vip, billing"
      }
    },
    "is_muted": false,
    "chat_name": "Example Corp Support",
    "chat_type": "group",
    "org_phone": "911111111111@c.us",
    "chat_image": "https://example.com/files/image.png",
    "created_at": "2026-01-10T08:00:00+00:00",
    "chat_labels": "customer, priority",
    "invite_link": null,
    "group_description": null,
    "custom_properties": {
      "Region": "EMEA"
    },
    "freshdesk_metadata": {},
    "zohodesk_metadata": {},
    "initiated_by": null,
    "is_archived": false,
    "parent_community_id": null
  },
  "message": {
    "message_id": "false_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "chat_id": "120363000000000000@g.us",
    "org_phone": "911111111111@c.us",
    "timestamp": "2026-01-15T09:28:00+00:00",
    "body": "I cannot open my invoices from the portal",
    "media_path": "",
    "sender_phone": "911111111111",
    "sender_name": "Rahul Sharma",
    "performed_by": null
  },
  "ticket": {
    "ticket_id": "ACM-001",
    "org_id": "00000000-0000-0000-0000-000000000000",
    "subject": "Customer cannot access invoices",
    "status": "open",
    "priority": 2,
    "assignee": "user@example.com",
    "assigned_by": "",
    "raised_by": "api",
    "due_date": "2026-02-01 00:00:00+00",
    "ticket_labels": "urgent, billing",
    "ticket_custom_properties": {
      "Workspace": "Example Corp"
    },
    "quoted_message_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "created_at": "2026-01-15T09:30:00.000Z",
    "closed_at": null,
    "closed_by": null,
    "closed_message": null,
    "first_assigned_at": null,
    "is_deleted": false
  },
  "attached_messages": [
    {
      "message_id": "false_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "chat_id": "120363000000000000@g.us",
      "org_phone": "911111111111@c.us",
      "timestamp": "2026-01-15T09:28:00+00:00",
      "body": "I cannot open my invoices from the portal",
      "media_path": "",
      "sender_phone": "911111111111",
      "sender_name": "Rahul Sharma",
      "performed_by": null
    }
  ]
}
```

**Attributes**

**chat** `object`

The chat the ticket is raised on. null in the rare case the chat record is no longer available.

**properties**

**org\_id** `string`

Id of the organization the chat belongs to

**chat\_id** `string`

Unique id of the chat — \<countrycode>\<number>@c.us for 1-1 chats, \<group-id>@g.us for group chats

**members** `object`

Participants of the chat, as a map of contact\_id → member. null when no participants are recorded.

**each value**

**contact\_id** `string`

Contact id of the member, suffixed with @c.us

**chat\_id** `string`

Chat the membership belongs to

**org\_id** `string`

Id of the organization

**org\_phone** `string`

Org phone (WhatsApp account) the chat belongs to, suffixed with @c.us

**is\_admin** `boolean`

Whether the member is an admin of the group chat

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

Whether the member is the super admin (creator) of the group chat

**contact\_name** `string`

Saved name of the contact. null when not a saved contact.

**contact\_image** `string`

URL of the profile image of the contact, when available

**contact\_color** `string`

Hex color assigned to the contact in the dashboard

**is\_internal** `boolean`

Whether the contact is an internal (workspace) contact rather than an external customer

**contact\_labels** `string`

Names of the labels applied to the contact, joined with ", ". An empty string when the contact has no labels.

**is\_muted** `boolean`

Whether the chat is muted on the phone

**chat\_name** `string`

Display name of the chat

**chat\_type** `string`

Type of the chat: 'user' for 1-1 chats, 'group' for groups

**org\_phone** `string`

Org phone (WhatsApp account) the chat belongs to, suffixed with @c.us

**chat\_image** `string`

URL of the chat image, when available

**created\_at** `string`

When the chat was created, as an ISO 8601 timestamp

**chat\_labels** `string`

Names of the labels applied to the chat, joined with ", ". An empty string when the chat has no labels.

**invite\_link** `string`

WhatsApp invite link of the group. null for 1-1 chats or when not available.

**group\_description** `string`

Description of the group. null for 1-1 chats.

**custom\_properties** `object`

Values of every chat custom property of the workspace, as a map of property name → formatted display value (an empty string for properties not set on this chat). Property definitions are managed via the Properties endpoints (see the CustomProperty component).

**freshdesk\_metadata** `object`

Sync metadata of the Freshdesk integration, when connected

**zohodesk\_metadata** `object`

Sync metadata of the Zoho Desk integration, when connected

**initiated\_by** `string`

Who initiated the chat, when known (e.g. the org phone or the contact)

**is\_archived** `boolean`

Whether the chat is archived on the phone

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

Id of the parent WhatsApp community when the group belongs to one. null otherwise.

**message** `object`

The message the ticket was raised from (quoted\_message\_id). Always present as an object — every field in it is null when the ticket is not linked to a message.

**properties**

**message\_id** `string`

Unique id of the message. Like every field of this object, null when the ticket has no linked message.

**chat\_id** `string`

Chat the message belongs to

**org\_phone** `string`

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

**timestamp** `string`

When the message was sent, as an ISO 8601 timestamp

**body** `string`

Text content of the message. An empty string for media-only messages.

**media\_path** `string`

URL of the message attachment. An empty string when the message has no media.

**sender\_phone** `string`

Phone number of the sender, as country code + number without the @c.us suffix

**sender\_name** `string`

Contact name of the sender. An empty string when the sender is not a saved contact.

**performed\_by** `string`

Who sent the message through Periskope: a member's email or 'api'. null for messages received from WhatsApp.

**ticket** `object`

The ticket itself

**properties**

**ticket\_id** `string`

Unique human-readable id of the ticket

**org\_id** `string`

Id of the organization the ticket belongs to

**subject** `string`

Subject of the ticket

**status** `string`

Lifecycle status of the ticket: 'open', 'inprogress', 'closed' or 'archived' One of: `open`, `inprogress`, `closed`, `archived`.

**priority** `integer`

Priority of the ticket: 1 (low), 2 (medium), 3 (high) or 4 (urgent). Tickets with no priority set are reported as 1 here.

**assignee** `string`

Email of the member the ticket is assigned to. An empty string when unassigned.

**assigned\_by** `string`

Email of the member who assigned the ticket. An empty string when it has not been assigned.

**raised\_by** `string`

Who raised the ticket: a member's email, or 'api' when created via the API

**due\_date** `string`

Due date of the ticket as a timestamp string (e.g. 2026-02-01 00:00:00+00). An empty string when no due date is set.

**ticket\_labels** `string`

Names of the ticket labels applied to the ticket, joined with ", ". An empty string when the ticket has no labels.

**ticket\_custom\_properties** `object`

Values of every ticket custom property of the workspace, as a map of property name → formatted display value (an empty string for properties not set on this ticket; option ids are resolved to their labels). Property definitions are managed via the Properties endpoints (see the CustomProperty component).

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

Unique id of the message the ticket was raised from. null when the ticket is not linked to a message.

**created\_at** `string`

When the ticket was created, as an ISO 8601 timestamp

**closed\_at** `string`

When the ticket was closed, as an ISO 8601 timestamp. null while the ticket is not closed.

**closed\_by** `string`

Who closed the ticket: a member's email, or 'api' when closed via the API without a closed\_by value. null while the ticket is not closed.

**closed\_message** `string`

Closing message supplied when the ticket was closed. null while the ticket is not closed or when none was given.

**first\_assigned\_at** `string`

When the ticket was first assigned to a member, as an ISO 8601 timestamp. null when it has never been assigned.

**is\_deleted** `boolean`

Whether the ticket has been deleted

**attached\_messages** `object[]`

Messages attached to the ticket. Populated only by GET /tickets/\{ticket\_id} — always an empty array in create and update responses.

**each item**

**message\_id** `string`

Unique id of the message. Like every field of this object, null when the ticket has no linked message.

**chat\_id** `string`

Chat the message belongs to

**org\_phone** `string`

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

**timestamp** `string`

When the message was sent, as an ISO 8601 timestamp

**body** `string`

Text content of the message. An empty string for media-only messages.

**media\_path** `string`

URL of the message attachment. An empty string when the message has no media.

**sender\_phone** `string`

Phone number of the sender, as country code + number without the @c.us suffix

**sender\_name** `string`

Contact name of the sender. An empty string when the sender is not a saved contact.

**performed\_by** `string`

Who sent the message through Periskope: a member's email or 'api'. null for messages received from WhatsApp.


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