Skip to main content
GET
/
pinned-messages
List Pinned Messages
curl --request GET \
  --url http://localhost:8080/pinned-messages
{
  "items": [
    {
      "id": 123,
      "content": "<string>",
      "send_before_menu": true,
      "send_on_every_start": true,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "media_type": "<string>",
      "media_file_id": "<string>",
      "created_by": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
active_only
boolean
default:false

Response

Successful Response

items
PinnedMessageResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required