> ## 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. # Get Reactions > Returns emoji reactions across the workspace, newest first. Filter by chat_id and/or message_id. ## OpenAPI ````yaml api-reference/openapi-generated.json GET /v1/reactions openapi: 3.0.3 info: title: Periskope API version: 1.0.0 description: >- Periskope external API. Responses use a flat, unwrapped shape: most endpoints return the resource at the top level, and list endpoints return a wrapper object with pagination inline (e.g. `{ from, to, count, chats: [...] }`). The documented response schemas describe these shapes directly. servers: - url: https://api.periskope.app security: - bearerAuth: [] paths: /v1/reactions: get: tags: - Reactions summary: List reactions description: >- Returns emoji reactions across the workspace, newest first. Filter by chat_id and/or message_id. operationId: listReactions parameters: - schema: type: integer nullable: true minimum: 0 description: >- Number of records to skip before the first returned record. Use together with limit to paginate: page N is offset = N * limit. Defaults to 0. example: 0 required: false description: >- Number of records to skip before the first returned record. Use together with limit to paginate: page N is offset = N * limit. Defaults to 0. name: offset in: query - schema: type: integer minimum: 1 description: Maximum number of records to return in one page. Defaults to 500. example: 500 required: false description: Maximum number of records to return in one page. Defaults to 500. name: limit in: query - schema: type: string description: >- Only return records at or after this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision. example: '2026-01-01T00:00:00Z' required: false description: >- Only return records at or after this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision. name: start_time in: query - schema: type: string description: >- Only return records at or before this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision. example: '2026-01-31T23:59:00Z' required: false description: >- Only return records at or before this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision. name: end_time in: query - schema: type: string description: >- Only return reactions in this chat. For group chats, the chat_id ending with @g.us; for 1-1 chats, country code + number of the contact suffixed with @c.us, e.g. 911111111111@c.us. Omit to return reactions across all chats. example: 120363000000000000@g.us required: false description: >- Only return reactions in this chat. For group chats, the chat_id ending with @g.us; for 1-1 chats, country code + number of the contact suffixed with @c.us, e.g. 911111111111@c.us. Omit to return reactions across all chats. name: chat_id in: query - schema: type: string description: >- Only return reactions on this message — the unique message_id of the message on Periskope, in the form ___. Omit to return reactions across all messages. example: >- false_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAA_922222222222@c.us required: false description: >- Only return reactions on this message — the unique message_id of the message on Periskope, in the form ___. Omit to return reactions across all messages. name: message_id in: query - schema: type: string example: '919876543210' description: >- Optional. Scope results to a single phone: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). Omit to return data across all phones the API token can access. required: false description: >- Optional. Scope results to a single phone: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). Omit to return data across all phones the API token can access. name: x-phone in: header responses: '200': description: Paginated list of reactions content: application/json: schema: type: object properties: from: type: integer description: >- 1-based index of the first record in this page (offset + 1). example: 1 to: type: integer description: 1-based index of the last record in this page. example: 20 count: type: integer description: >- Number of records in this page — the length of the `reactions` array, not the total across all pages. example: 20 start_time: type: string description: >- Echo of the start_time filter, present only when it was sent. example: '2026-01-01T00:00:00Z' end_time: type: string description: >- Echo of the end_time filter, present only when it was sent. reactions: type: array items: $ref: '#/components/schemas/Reaction' description: The reactions in this page. examples: default: summary: Response body value: from: 1 to: 20 count: 20 start_time: '2026-01-01T00:00:00Z' end_time: null reactions: - reaction_id: >- true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA_911111111111@c.us org_id: 00000000-0000-0000-0000-000000000000 org_phone: 911111111111@c.us chat_id: 120363000000000000@g.us message_id: >- false_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAA_922222222222@c.us sender_id: 911111111111@c.us reaction: 👍 timestamp: '2026-01-15T09:30:00+00:00' ack: 3 read: true id: id: AAAAAAAAAAAAAAAAAAAAAA fromMe: true remote: 120363000000000000@g.us _serialized: >- true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA_911111111111@c.us participant: 911111111111@c.us msg_id: id: AAAAAAAAAAAAAAAAAAAAAA fromMe: true remote: 120363000000000000@g.us _serialized: >- true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA_911111111111@c.us participant: 911111111111@c.us unique_id: AAAAAAAAAAAAAAAAAAAA orphan: 0 orphan_reason: null '401': description: Invalid, expired or missing API token content: application/json: examples: error: summary: Invalid, expired or missing API token value: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 schema: type: object properties: code: type: string example: UNAUTHORIZED_ERROR message: type: string example: Invalid bearer auth token status: type: integer example: 401 example: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 '422': description: Request validation failed content: application/json: examples: error: summary: Request validation failed value: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required schema: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: Request validation failed status: type: integer example: 422 fields: type: object additionalProperties: type: object properties: message: type: string value: {} example: body.chat_id: message: chat_id is required example: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required '429': description: Rate limit exceeded content: application/json: examples: error: summary: Rate limit exceeded value: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 schema: type: object properties: code: type: string example: RATE_LIMIT_ERROR message: type: string example: You can only make 100 requests per second status: type: integer example: 429 example: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 '500': description: Internal server error content: application/json: examples: error: summary: Internal server error value: code: UNKNOWN_ERROR message: Internal server error status: 500 schema: type: object properties: code: type: string example: UNKNOWN_ERROR message: type: string example: Internal server error status: type: integer example: 500 example: code: UNKNOWN_ERROR message: Internal server error status: 500 security: - bearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: |- import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', phone: '919876543210', // the phone to act with (x-phone) }); async function main() { const response = await client.reactions.listReactions(); console.log(response); } main(); - lang: bash label: cURL source: |- curl -X GET 'https://api.periskope.app/v1/reactions' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'x-phone: 919876543210' components: schemas: Reaction: type: object properties: reaction_id: type: string description: >- Unique id of the reaction — the serialized WhatsApp id of the reaction event, in the form ___ example: >- true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA_911111111111@c.us org_id: type: string format: uuid description: Id of the organization the reaction belongs to example: 00000000-0000-0000-0000-000000000000 org_phone: type: string description: >- Org phone (WhatsApp account) the reaction was synced under, as country code + number suffixed with @c.us. Pass the x-phone header to scope results to one org phone. example: 911111111111@c.us chat_id: type: string description: >- Chat the reaction happened in — @g.us for group chats, @c.us for 1-1 chats. Use it as the chat_id query filter. example: 120363000000000000@g.us message_id: type: string description: >- message_id of the message that was reacted to, in the form ___. Use it as the message_id query filter to fetch all reactions on one message. example: false_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAA_922222222222@c.us sender_id: type: string description: >- WhatsApp id of who sent the reaction, as @c.us. This is the org phone itself when the reaction was sent from the connected phone. example: 911111111111@c.us reaction: type: string description: >- The reaction emoji. Empty or null when the record carries no emoji (e.g. the sender removed their reaction). example: 👍 timestamp: type: string description: >- When the reaction was sent, as an ISO 8601 timestamp. Reactions are ordered by this field (newest first) and filtered on it by start_time/end_time. example: '2026-01-15T09:30:00+00:00' ack: type: integer description: >- Delivery status of the reaction, tracked for reactions sent by the org phone: -1 failed, 0 pending, 1 sent to WhatsApp servers, 2 delivered to WhatsApp, 3 delivered to the recipient, 4 read, 5 played. null when not tracked. example: 3 read: type: boolean description: >- Whether the reaction has been marked as read in Periskope. null when not tracked. example: true id: $ref: '#/components/schemas/ReactionWaId' msg_id: allOf: - $ref: '#/components/schemas/ReactionWaId' - description: >- Raw WhatsApp id object of the message that was reacted to. null when not available. example: id: AAAAAAAAAAAAAAAAAAAA fromMe: false remote: 120363000000000000@g.us _serialized: >- false_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAA_922222222222@c.us participant: 911111111111@c.us unique_id: type: string description: >- The WhatsApp message id portion of the reacted-to message (msg_id.id). null when not available. example: AAAAAAAAAAAAAAAAAAAA orphan: type: integer description: >- Internal flag set by the WhatsApp sync pipeline. 0 or null for reactions that synced normally. example: 0 orphan_reason: type: string description: >- Internal reason recorded by the sync pipeline when orphan is set. null for reactions that synced normally. example: null description: >- An emoji reaction on a WhatsApp message, synced from a connected org phone. Reactions reference the message they were applied to via message_id and carry who reacted (sender_id) and with which emoji (reaction). ReactionWaId: type: object properties: id: type: string description: >- The WhatsApp message id — the unique id WhatsApp assigns to the message on the device example: AAAAAAAAAAAAAAAAAAAAAA fromMe: type: boolean description: >- Whether the message was sent by the connected org phone (true) or received from a contact (false) example: true remote: type: string description: >- The chat the message belongs to — @g.us for group chats, @c.us for 1-1 chats example: 120363000000000000@g.us _serialized: type: string description: >- The full serialized id, in the form __ with the sender appended in group chats example: >- true_120363000000000000@g.us_AAAAAAAAAAAAAAAAAAAAAA_911111111111@c.us participant: type: string description: >- WhatsApp id of the sending participant within a group chat, as @c.us. Absent for 1-1 chats. example: 911111111111@c.us description: >- Raw WhatsApp id object of the reaction event itself. null when not available. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your Periskope API token, sent as `Authorization: Bearer `. Generate one from the Periskope dashboard under **Settings → API & Webhooks**. API access requires an active Pro or Enterprise plan. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.