---
title: "Get a list of the pins of the calling agent"
method: GET
path: "/service_agents/talk_pins"
tags: ["Service Agent"]
---

# Get a list of the pins of the calling agent

`GET /service_agents/talk_pins`

## Request

- Base URL: `https://api.voipbin.net/v1.0`
- URL: `https://api.voipbin.net/v1.0/service_agents/talk_pins`
- Auth: none declared
- TypeScript: <https://skmtc.dev/voipbin/apis/voipbin-api/docs/service_agents/talk_pins/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the chats and messages that the calling agent has pinned, newest first. Only the
agent's own pins are returned. A pin is listed only while the agent can still see its target:
the chat is not deleted, and in a direct or group chat the agent is still a participant (the
pin reappears when the agent joins again). A pinned message that was deleted is not listed.
A pin of a message carries the pinned message in `message` in this list; the responses of POST and DELETE do not include it.

## Query parameters

- `target_type` 'chat' | 'message': What a pin points to.
- `chat_id` string, uuid
- `page_size` integer
- `page_token` string

## Response `200`

A list of the pins of the calling agent.

- object
  - `next_page_token` string: Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.
  - `result` TalkManagerPin[]
    - `id` string, uuid: The pin ID returned from POST /service_agents/talk_pins or GET /service_agents/talk_pins.
    - `target_type` 'chat' | 'message': What a pin points to.
    - `target_id` string, uuid: The chat ID returned from GET /service_agents/talk_chats, or the message ID returned from GET /service_agents/talk_messages, depending on target_type.
    - `chat_id` string, uuid: The chat the pinned chat or message belongs to. The ID is returned from GET /service_agents/talk_chats.
    - `message` TalkManagerMessage
      - `id` string, uuid: The unique identifier of the message. Returned from the `POST /service_agents/talk_messages` or `GET /service_agents/talk_messages` response.
      - `customer_id` string, uuid: The unique identifier of the customer who owns this message. Returned from the `GET /customers` response.
      - `owner_type` string: Resource's owner type.
      - `owner_id` string, uuid: The unique identifier of the message author. Returned from the corresponding owner resource endpoint.
      - `chat_id` string, uuid: The unique identifier of the talk this message belongs to. Returned from the `GET /service_agents/talk_chats` response.
      - `parent_id` string, uuid: The unique identifier of the parent message (for threaded replies). Returned from the `GET /service_agents/talk_messages` response.
      - `type` 'normal' | 'system': Type of the message.
      - `text` string: Message text content.
      - `medias` TalkManagerMedia[]: Media attachments.
        - `type` 'address' | 'agent' | 'file' | 'link': Type of the media content.
        - `address` CommonAddress: Contains source or destination detail info.
          - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session': Type of address.
          - `target` string: The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
          - `target_name` string: Address's name.
          - `name` string: Optional label for this address.
          - `detail` string: Additional notes about this address.
        - `agent_id` string, uuid: The unique identifier of the agent. Valid only if the type is `agent`. Returned from the `GET /agents` response.
        - `file_id` string, uuid: The unique identifier of the file. Valid only if the type is `file`. Returned from the `GET /storage_files` response.
        - `link_url` string, uri: The URL of the linked resource. Valid only if the type is `link`.
      - `metadata` TalkManagerMetadata
        - `reactions` TalkManagerReaction[]: List of reactions on the message.
          - `emoji` string: Emoji character for the reaction.
          - `owner_type` string: Type of the owner who reacted.
          - `owner_id` string, uuid: The unique identifier of the owner who reacted. Returned from the corresponding owner resource endpoint (e.g., `GET /agents`).
          - `tm_create` string, date-time: Timestamp when the reaction was created.
      - `tm_create` string, date-time: Timestamp when the message was created.
      - `tm_update` string, date-time: Timestamp when the message was last updated.
      - `tm_delete` string, date-time: Timestamp when the message was deleted.
    - `tm_create` string, date-time: Timestamp when the pin was created.

## Other responses

- `400`: Invalid request (INVALID_ARGUMENT).
- `401`: Authentication required (UNAUTHENTICATED).
- `403`: Insufficient permission (PERMISSION_DENIED).
- `500`: Internal error (INTERNAL).

## Changes

- **2026-11-02** `27887286af74`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/voipbin/apis/voipbin-api/changes/service_agents/talk_pins/get.md)

---

[API](https://skmtc.dev/voipbin/apis/voipbin-api.md) - [All operations](https://skmtc.dev/voipbin/apis/voipbin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/voipbin/apis/voipbin-api/revisions/ae049dcc6c89?raw)