Ticket APIs
Get Ticket By ID
API
- Introduction
- Authorization
- Objects
Chat APIs
Group Settings APIs
Message APIs
Ticket APIs
Get Ticket By ID
This endpoint retrieves a specific ticket along with the associated chat, and messages
curl --request GET \
--url https://api.periskope.app/v1/tickets/{ticket_id} \
--header 'Authorization: Bearer <token>'
{
"attached_messages": [],
"chat": {
"chat_id": "919537851844@c.us",
"chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
"chat_labels": "chatlabel1, chatlabel2",
"chat_name": "BK Local1",
"chat_type": "user",
"created_at": "2025-01-18T14:51:03+00:00",
"custom_properties": {
"Custom Property 1": "hello"
},
"group_description": null,
"invite_link": null,
"is_muted": false,
"members": {
"918527184400@c.us": {
"chat_id": "919537851844@c.us",
"contact_color": "#FA6533",
"contact_id": "918527184400@c.us",
"contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
"contact_labels": "",
"contact_name": "Support",
"is_admin": true,
"is_internal": true,
"is_super_admin": true,
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us"
},
"919537851844@c.us": {
"chat_id": "919537851844@c.us",
"contact_color": "#B4876E",
"contact_id": "919537851844@c.us",
"contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
"contact_labels": "label1, label2",
"contact_name": "BK Local1",
"is_admin": true,
"is_internal": false,
"is_super_admin": true,
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us"
}
},
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us"
},
"message": {
"body": "You have been invited to join Test New 1039\n\nhttps://chat.whatsapp.com/invite/CGiTdfn1dUM8J67GEx1lyx\n\nIf you cannot click the link, please respond to this message, and the link will become active",
"chat_id": "919537851844@c.us",
"media_path": "",
"message_id": "true_919537851844@c.us_3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
"org_phone": "918527184400@c.us",
"performed_by": null,
"sender_name": "Support",
"sender_phone": "918527184400",
"timestamp": "2025-01-24T05:11:08+00:00"
},
"ticket": {
"assigned_by": "",
"assignee": "bharat@periskope.app",
"created_at": "2025-01-26T13:46:21.670006+00:00",
"due_date": "",
"is_deleted": false,
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"priority": 1,
"quoted_message_id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
"raised_by": null,
"status": "open",
"subject": "Issue with this",
"ticket_custom_properties": {},
"ticket_id": "BKT-001",
"ticket_labels": ""
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
- The unique identifier of the ticket
Example:
"BKT-001"
Response
200 - application/json
200 OK
The response is a ticket object, which also includes the chat and message details. Refer to the ticket object here
Was this page helpful?
curl --request GET \
--url https://api.periskope.app/v1/tickets/{ticket_id} \
--header 'Authorization: Bearer <token>'
{
"attached_messages": [],
"chat": {
"chat_id": "919537851844@c.us",
"chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
"chat_labels": "chatlabel1, chatlabel2",
"chat_name": "BK Local1",
"chat_type": "user",
"created_at": "2025-01-18T14:51:03+00:00",
"custom_properties": {
"Custom Property 1": "hello"
},
"group_description": null,
"invite_link": null,
"is_muted": false,
"members": {
"918527184400@c.us": {
"chat_id": "919537851844@c.us",
"contact_color": "#FA6533",
"contact_id": "918527184400@c.us",
"contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737690126280",
"contact_labels": "",
"contact_name": "Support",
"is_admin": true,
"is_internal": true,
"is_super_admin": true,
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us"
},
"919537851844@c.us": {
"chat_id": "919537851844@c.us",
"contact_color": "#B4876E",
"contact_id": "919537851844@c.us",
"contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737689973340",
"contact_labels": "label1, label2",
"contact_name": "BK Local1",
"is_admin": true,
"is_internal": false,
"is_super_admin": true,
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us"
}
},
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us"
},
"message": {
"body": "You have been invited to join Test New 1039\n\nhttps://chat.whatsapp.com/invite/CGiTdfn1dUM8J67GEx1lyx\n\nIf you cannot click the link, please respond to this message, and the link will become active",
"chat_id": "919537851844@c.us",
"media_path": "",
"message_id": "true_919537851844@c.us_3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
"org_phone": "918527184400@c.us",
"performed_by": null,
"sender_name": "Support",
"sender_phone": "918527184400",
"timestamp": "2025-01-24T05:11:08+00:00"
},
"ticket": {
"assigned_by": "",
"assignee": "bharat@periskope.app",
"created_at": "2025-01-26T13:46:21.670006+00:00",
"due_date": "",
"is_deleted": false,
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"priority": 1,
"quoted_message_id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
"raised_by": null,
"status": "open",
"subject": "Issue with this",
"ticket_custom_properties": {},
"ticket_id": "BKT-001",
"ticket_labels": ""
}
}