Skip to main content
GET
/
channels
/
{channel_id}
/
messages
/
pins
cURL
curl --request GET \
  --url https://discord.com/api/v10/channels/{channel_id}/messages/pins \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "pinned_at": "2023-11-07T05:31:56Z",
      "message": {
        "type": 123,
        "content": "<string>",
        "mentions": [
          {
            "id": "<string>",
            "username": "<string>",
            "avatar": "<string>",
            "discriminator": "<string>",
            "public_flags": 123,
            "flags": 0,
            "global_name": "<string>",
            "primary_guild": "<unknown>",
            "bot": true,
            "system": true,
            "banner": "<string>",
            "accent_color": 123,
            "avatar_decoration_data": "<unknown>",
            "collectibles": "<unknown>"
          }
        ],
        "mention_roles": [
          "<string>"
        ],
        "attachments": [
          {
            "id": "<string>",
            "filename": "<string>",
            "size": 123,
            "url": "<string>",
            "proxy_url": "<string>",
            "width": 123,
            "height": 123,
            "duration_secs": 123,
            "waveform": "<string>",
            "description": "<string>",
            "content_type": "<string>",
            "ephemeral": true,
            "title": "<string>",
            "application": {
              "id": "<string>",
              "name": "<string>",
              "icon": "<string>",
              "description": "<string>",
              "type": "<unknown>",
              "verify_key": "<string>",
              "flags": 123,
              "cover_image": "<string>",
              "primary_sku_id": "<string>",
              "bot": {
                "id": "<string>",
                "username": "<string>",
                "avatar": "<string>",
                "discriminator": "<string>",
                "public_flags": 123,
                "flags": 0,
                "global_name": "<string>",
                "primary_guild": "<unknown>",
                "bot": true,
                "system": true,
                "banner": "<string>",
                "accent_color": 123,
                "avatar_decoration_data": "<unknown>",
                "collectibles": "<unknown>"
              },
              "slug": "<string>",
              "guild_id": "<string>",
              "rpc_origins": [
                "<string>"
              ],
              "bot_public": true,
              "bot_require_code_grant": true,
              "terms_of_service_url": "<string>",
              "privacy_policy_url": "<string>",
              "custom_install_url": "<string>",
              "install_params": {
                "scopes": [
                  "applications.commands"
                ],
                "permissions": "<string>"
              },
              "integration_types_config": {},
              "max_participants": 123,
              "tags": [
                "<string>"
              ]
            },
            "clip_created_at": "2023-11-07T05:31:56Z",
            "clip_participants": [
              {
                "id": "<string>",
                "username": "<string>",
                "avatar": "<string>",
                "discriminator": "<string>",
                "public_flags": 123,
                "flags": 0,
                "global_name": "<string>",
                "primary_guild": "<unknown>",
                "bot": true,
                "system": true,
                "banner": "<string>",
                "accent_color": 123,
                "avatar_decoration_data": "<unknown>",
                "collectibles": "<unknown>"
              }
            ]
          }
        ],
        "embeds": [
          {
            "type": "<string>",
            "url": "<string>",
            "title": "<string>",
            "description": "<string>",
            "color": 123,
            "timestamp": "2023-11-07T05:31:56Z",
            "fields": [
              {
                "name": "<string>",
                "value": "<string>",
                "inline": true
              }
            ],
            "author": {
              "name": "<string>",
              "url": "<string>",
              "icon_url": "<string>",
              "proxy_icon_url": "<string>"
            },
            "provider": {
              "name": "<string>",
              "url": "<string>"
            },
            "image": {
              "url": "<string>",
              "proxy_url": "<string>",
              "width": 2147483647,
              "height": 2147483647,
              "content_type": "<string>",
              "placeholder": "<string>",
              "placeholder_version": 2147483647,
              "description": "<string>",
              "flags": 2147483647
            },
            "thumbnail": {
              "url": "<string>",
              "proxy_url": "<string>",
              "width": 2147483647,
              "height": 2147483647,
              "content_type": "<string>",
              "placeholder": "<string>",
              "placeholder_version": 2147483647,
              "description": "<string>",
              "flags": 2147483647
            },
            "video": {
              "url": "<string>",
              "proxy_url": "<string>",
              "width": 2147483647,
              "height": 2147483647,
              "content_type": "<string>",
              "placeholder": "<string>",
              "placeholder_version": 2147483647,
              "description": "<string>",
              "flags": 2147483647
            },
            "footer": {
              "text": "<string>",
              "icon_url": "<string>",
              "proxy_icon_url": "<string>"
            }
          }
        ],
        "timestamp": "2023-11-07T05:31:56Z",
        "edited_timestamp": "2023-11-07T05:31:56Z",
        "flags": 123,
        "components": [
          {
            "type": 1,
            "id": 123,
            "components": [
              {
                "type": 2,
                "id": 123,
                "style": 123,
                "custom_id": "<string>",
                "label": "<string>",
                "disabled": true,
                "emoji": {
                  "name": "<string>",
                  "id": "<string>",
                  "animated": true
                },
                "url": "<string>",
                "sku_id": "<string>"
              }
            ]
          }
        ],
        "id": "<string>",
        "channel_id": "<string>",
        "author": {
          "id": "<string>",
          "username": "<string>",
          "avatar": "<string>",
          "discriminator": "<string>",
          "public_flags": 123,
          "flags": 0,
          "global_name": "<string>",
          "primary_guild": "<unknown>",
          "bot": true,
          "system": true,
          "banner": "<string>",
          "accent_color": 123,
          "avatar_decoration_data": "<unknown>",
          "collectibles": "<unknown>"
        },
        "pinned": true,
        "mention_everyone": true,
        "tts": true,
        "stickers": [
          {
            "id": "<string>",
            "name": "<string>",
            "tags": "<string>",
            "type": 2,
            "format_type": "<unknown>",
            "description": "<string>",
            "available": true,
            "guild_id": "<string>",
            "user": {
              "id": "<string>",
              "username": "<string>",
              "avatar": "<string>",
              "discriminator": "<string>",
              "public_flags": 123,
              "flags": 0,
              "global_name": "<string>",
              "primary_guild": "<unknown>",
              "bot": true,
              "system": true,
              "banner": "<string>",
              "accent_color": 123,
              "avatar_decoration_data": "<unknown>",
              "collectibles": "<unknown>"
            }
          }
        ],
        "sticker_items": [
          {
            "id": "<string>",
            "name": "<string>",
            "format_type": 123
          }
        ],
        "call": {
          "participants": [
            "<string>"
          ],
          "ended_timestamp": "2023-11-07T05:31:56Z"
        },
        "activity": {},
        "application": {
          "id": "<string>",
          "name": "<string>",
          "icon": "<string>",
          "description": "<string>",
          "type": "<unknown>",
          "cover_image": "<string>",
          "primary_sku_id": "<string>",
          "bot": {
            "id": "<string>",
            "username": "<string>",
            "avatar": "<string>",
            "discriminator": "<string>",
            "public_flags": 123,
            "flags": 0,
            "global_name": "<string>",
            "primary_guild": "<unknown>",
            "bot": true,
            "system": true,
            "banner": "<string>",
            "accent_color": 123,
            "avatar_decoration_data": "<unknown>",
            "collectibles": "<unknown>"
          }
        },
        "application_id": "<string>",
        "interaction": {
          "id": "<string>",
          "type": 123,
          "name": "<string>",
          "user": {
            "id": "<string>",
            "username": "<string>",
            "avatar": "<string>",
            "discriminator": "<string>",
            "public_flags": 123,
            "flags": 0,
            "global_name": "<string>",
            "primary_guild": "<unknown>",
            "bot": true,
            "system": true,
            "banner": "<string>",
            "accent_color": 123,
            "avatar_decoration_data": "<unknown>",
            "collectibles": "<unknown>"
          },
          "name_localized": "<string>"
        },
        "nonce": 0,
        "webhook_id": "<string>",
        "message_reference": {
          "type": 123,
          "channel_id": "<string>",
          "message_id": "<string>",
          "guild_id": "<string>"
        },
        "thread": {
          "id": "<string>",
          "type": 10,
          "flags": 123,
          "guild_id": "<string>",
          "name": "<string>",
          "owner_id": "<string>",
          "thread_metadata": {
            "archived": true,
            "archive_timestamp": "2023-11-07T05:31:56Z",
            "auto_archive_duration": 123,
            "locked": true,
            "create_timestamp": "2023-11-07T05:31:56Z",
            "invitable": true
          },
          "message_count": 123,
          "member_count": 123,
          "total_message_sent": 123,
          "last_message_id": "<unknown>",
          "last_pin_timestamp": "2023-11-07T05:31:56Z",
          "parent_id": "<unknown>",
          "rate_limit_per_user": 123,
          "bitrate": 123,
          "user_limit": 123,
          "rtc_region": "<string>",
          "video_quality_mode": 123,
          "permissions": "<string>",
          "applied_tags": [
            "<string>"
          ],
          "member": {
            "id": "<string>",
            "user_id": "<string>",
            "join_timestamp": "2023-11-07T05:31:56Z",
            "flags": 123,
            "member": {
              "avatar": "<string>",
              "banner": "<string>",
              "communication_disabled_until": "2023-11-07T05:31:56Z",
              "flags": 123,
              "joined_at": "2023-11-07T05:31:56Z",
              "nick": "<string>",
              "pending": true,
              "premium_since": "2023-11-07T05:31:56Z",
              "roles": [
                "<string>"
              ],
              "user": {
                "id": "<string>",
                "username": "<string>",
                "avatar": "<string>",
                "discriminator": "<string>",
                "public_flags": 123,
                "flags": 0,
                "global_name": "<string>",
                "primary_guild": "<unknown>",
                "bot": true,
                "system": true,
                "banner": "<string>",
                "accent_color": 123,
                "avatar_decoration_data": "<unknown>",
                "collectibles": "<unknown>"
              },
              "mute": true,
              "deaf": true,
              "avatar_decoration_data": "<unknown>",
              "collectibles": "<unknown>"
            }
          }
        },
        "mention_channels": [
          "<unknown>"
        ],
        "role_subscription_data": {
          "role_subscription_listing_id": "<string>",
          "tier_name": "<string>",
          "total_months_subscribed": 123,
          "is_renewal": true
        },
        "purchase_notification": {
          "type": 123,
          "guild_product_purchase": {
            "listing_id": "<string>",
            "product_name": "<string>"
          }
        },
        "position": 123,
        "resolved": {
          "users": {},
          "members": {},
          "channels": {},
          "roles": {}
        },
        "poll": {
          "question": {
            "text": "<string>",
            "emoji": {
              "id": "<unknown>",
              "name": "<string>",
              "animated": true
            }
          },
          "answers": [
            {
              "answer_id": 123,
              "poll_media": {
                "text": "<string>",
                "emoji": {
                  "id": "<unknown>",
                  "name": "<string>",
                  "animated": true
                }
              }
            }
          ],
          "expiry": "2023-11-07T05:31:56Z",
          "allow_multiselect": true,
          "layout_type": 123,
          "results": {
            "answer_counts": [
              {
                "id": 123,
                "count": 123,
                "me_voted": true
              }
            ],
            "is_finalized": true
          }
        },
        "shared_client_theme": "<unknown>",
        "interaction_metadata": {
          "id": "<string>",
          "type": 2,
          "authorizing_integration_owners": {},
          "user": {
            "id": "<string>",
            "username": "<string>",
            "avatar": "<string>",
            "discriminator": "<string>",
            "public_flags": 123,
            "flags": 0,
            "global_name": "<string>",
            "primary_guild": "<unknown>",
            "bot": true,
            "system": true,
            "banner": "<string>",
            "accent_color": 123,
            "avatar_decoration_data": "<unknown>",
            "collectibles": "<unknown>"
          },
          "original_response_message_id": "<string>",
          "target_user": {
            "id": "<string>",
            "username": "<string>",
            "avatar": "<string>",
            "discriminator": "<string>",
            "public_flags": 123,
            "flags": 0,
            "global_name": "<string>",
            "primary_guild": "<unknown>",
            "bot": true,
            "system": true,
            "banner": "<string>",
            "accent_color": 123,
            "avatar_decoration_data": "<unknown>",
            "collectibles": "<unknown>"
          },
          "target_message_id": "<string>"
        },
        "message_snapshots": [
          {
            "message": {
              "type": 123,
              "content": "<string>",
              "mentions": [
                {
                  "id": "<string>",
                  "username": "<string>",
                  "avatar": "<string>",
                  "discriminator": "<string>",
                  "public_flags": 123,
                  "flags": 0,
                  "global_name": "<string>",
                  "primary_guild": "<unknown>",
                  "bot": true,
                  "system": true,
                  "banner": "<string>",
                  "accent_color": 123,
                  "avatar_decoration_data": "<unknown>",
                  "collectibles": "<unknown>"
                }
              ],
              "mention_roles": [
                "<string>"
              ],
              "attachments": [
                {
                  "id": "<string>",
                  "filename": "<string>",
                  "size": 123,
                  "url": "<string>",
                  "proxy_url": "<string>",
                  "width": 123,
                  "height": 123,
                  "duration_secs": 123,
                  "waveform": "<string>",
                  "description": "<string>",
                  "content_type": "<string>",
                  "ephemeral": true,
                  "title": "<string>",
                  "application": {
                    "id": "<string>",
                    "name": "<string>",
                    "icon": "<string>",
                    "description": "<string>",
                    "type": "<unknown>",
                    "verify_key": "<string>",
                    "flags": 123,
                    "cover_image": "<string>",
                    "primary_sku_id": "<string>",
                    "bot": {
                      "id": "<string>",
                      "username": "<string>",
                      "avatar": "<string>",
                      "discriminator": "<string>",
                      "public_flags": 123,
                      "flags": 0,
                      "global_name": "<string>",
                      "primary_guild": "<unknown>",
                      "bot": true,
                      "system": true,
                      "banner": "<string>",
                      "accent_color": 123,
                      "avatar_decoration_data": "<unknown>",
                      "collectibles": "<unknown>"
                    },
                    "slug": "<string>",
                    "guild_id": "<string>",
                    "rpc_origins": [
                      "<string>"
                    ],
                    "bot_public": true,
                    "bot_require_code_grant": true,
                    "terms_of_service_url": "<string>",
                    "privacy_policy_url": "<string>",
                    "custom_install_url": "<string>",
                    "install_params": {
                      "scopes": [
                        "applications.commands"
                      ],
                      "permissions": "<string>"
                    },
                    "integration_types_config": {},
                    "max_participants": 123,
                    "tags": [
                      "<string>"
                    ]
                  },
                  "clip_created_at": "2023-11-07T05:31:56Z",
                  "clip_participants": [
                    {
                      "id": "<string>",
                      "username": "<string>",
                      "avatar": "<string>",
                      "discriminator": "<string>",
                      "public_flags": 123,
                      "flags": 0,
                      "global_name": "<string>",
                      "primary_guild": "<unknown>",
                      "bot": true,
                      "system": true,
                      "banner": "<string>",
                      "accent_color": 123,
                      "avatar_decoration_data": "<unknown>",
                      "collectibles": "<unknown>"
                    }
                  ]
                }
              ],
              "embeds": [
                {
                  "type": "<string>",
                  "url": "<string>",
                  "title": "<string>",
                  "description": "<string>",
                  "color": 123,
                  "timestamp": "2023-11-07T05:31:56Z",
                  "fields": [
                    {
                      "name": "<string>",
                      "value": "<string>",
                      "inline": true
                    }
                  ],
                  "author": {
                    "name": "<string>",
                    "url": "<string>",
                    "icon_url": "<string>",
                    "proxy_icon_url": "<string>"
                  },
                  "provider": {
                    "name": "<string>",
                    "url": "<string>"
                  },
                  "image": {
                    "url": "<string>",
                    "proxy_url": "<string>",
                    "width": 2147483647,
                    "height": 2147483647,
                    "content_type": "<string>",
                    "placeholder": "<string>",
                    "placeholder_version": 2147483647,
                    "description": "<string>",
                    "flags": 2147483647
                  },
                  "thumbnail": {
                    "url": "<string>",
                    "proxy_url": "<string>",
                    "width": 2147483647,
                    "height": 2147483647,
                    "content_type": "<string>",
                    "placeholder": "<string>",
                    "placeholder_version": 2147483647,
                    "description": "<string>",
                    "flags": 2147483647
                  },
                  "video": {
                    "url": "<string>",
                    "proxy_url": "<string>",
                    "width": 2147483647,
                    "height": 2147483647,
                    "content_type": "<string>",
                    "placeholder": "<string>",
                    "placeholder_version": 2147483647,
                    "description": "<string>",
                    "flags": 2147483647
                  },
                  "footer": {
                    "text": "<string>",
                    "icon_url": "<string>",
                    "proxy_icon_url": "<string>"
                  }
                }
              ],
              "timestamp": "2023-11-07T05:31:56Z",
              "edited_timestamp": "2023-11-07T05:31:56Z",
              "flags": 123,
              "components": [
                {
                  "type": 1,
                  "id": 123,
                  "components": [
                    {
                      "type": 2,
                      "id": 123,
                      "style": 123,
                      "custom_id": "<string>",
                      "label": "<string>",
                      "disabled": true,
                      "emoji": {
                        "name": "<string>",
                        "id": "<string>",
                        "animated": true
                      },
                      "url": "<string>",
                      "sku_id": "<string>"
                    }
                  ]
                }
              ],
              "stickers": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "tags": "<string>",
                  "type": 2,
                  "format_type": "<unknown>",
                  "description": "<string>",
                  "available": true,
                  "guild_id": "<string>",
                  "user": {
                    "id": "<string>",
                    "username": "<string>",
                    "avatar": "<string>",
                    "discriminator": "<string>",
                    "public_flags": 123,
                    "flags": 0,
                    "global_name": "<string>",
                    "primary_guild": "<unknown>",
                    "bot": true,
                    "system": true,
                    "banner": "<string>",
                    "accent_color": 123,
                    "avatar_decoration_data": "<unknown>",
                    "collectibles": "<unknown>"
                  }
                }
              ],
              "sticker_items": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "format_type": 123
                }
              ]
            }
          }
        ],
        "reactions": [
          {
            "emoji": {
              "id": "<unknown>",
              "name": "<string>",
              "animated": true
            },
            "count": 123,
            "count_details": {
              "burst": 123,
              "normal": 123
            },
            "burst_colors": [
              "<string>"
            ],
            "me_burst": true,
            "me": true
          }
        ],
        "referenced_message": "<unknown>"
      }
    }
  ],
  "has_more": true
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

channel_id
string<snowflake>
required

Query Parameters

before
string<date-time>
limit
integer
Required range: 1 <= x <= 50

Response

200 response for list_pins

items
object[]
required
has_more
boolean
required