Get user story highlights

Returns the list of story highlight reels on a user’s profile. Use the highlight endpoint to get individual stories within a highlight.

What it does

Returns the list of story highlight reels on a user’s profile. Use the highlight endpoint to get individual stories within a highlight.

Tool details

Field	Value
Tool name	instagram_get_user_highlights
Platform	Instagram
REST endpoint	GET /v1/instagram/users/{username}/highlights
Result type	Collection tool

Parameters

Parameter	Type	Required	Description
username	string	Yes	Instagram username (with or without @ symbol)
cursor	string	No	Pagination cursor
projection_preset	string	No	Defaults to minimal. Allowed values: full, minimal, identity, engagement, content.
data_fields	string[]	No	Adds top-level keys from data on top of the selected projection_preset.
item_fields	string[]	No	Adds keys from data.orderedItems[] on top of the selected projection_preset.

Example

{
  "name": "instagram_get_user_highlights",
  "arguments": {
    "username": "khaby.lame",
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "totalItems",
      "entityId",
      "name",
      "image",
      "id"
    ]
  }
}

Available data fields

• @context
• type
• partOf
• totalItems
• cursor
• nextCursor
• next
• itemCount
• orderedItems

Available item fields

• type
• id
• entityId
• name
• image
• totalItems

Response notes

Successful calls return a JSON object with a top-level data field and, when available, metadata.creditsUsed and metadata.creditsRemaining. See response format, pagination, and credits.