Skip to main content

​
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

FieldValue
Tool nameinstagram.get_user_highlights
PlatformInstagram
REST endpointGET /v1/instagram/users/{username}/highlights
Result typeCollection tool

​
Parameters

ParameterSourceTypeRequiredDescription
usernamepathstringYesInstagram username (with or without @ symbol)
cursorquerystringNoPagination cursor
projection_presetsharedstringNoOptional. Defaults to minimal. Allowed values: full, minimal, identity, engagement, content.
data_fieldssharedstring[]NoOptional. Adds top-level keys from data on top of the selected projection_preset.
item_fieldssharedstring[]NoOptional. 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.