> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ofauth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get story highlight

> Get a story highlight.

**Required scope:** `stories:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/stories/highlights/:highlightId
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth V3 API for linking accounts, making OnlyFans API requests, and
    receiving events.
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ExternalOAuth: []
tags:
  - name: Link
    description: Link accounts, get and refresh tokens, and end access.
  - name: Linked accounts
    description: The linked accounts of one authorization, and their settings.
  - name: Access
    description: Make OnlyFans API requests for a linked account.
  - name: Analytics
    description: 'Access: charts, rankings, and performance data.'
  - name: Earnings
    description: 'Access: earnings charts, transactions, and chargebacks.'
  - name: Messages
    description: 'Access: messaging, chats, queue, and mass messaging.'
  - name: Posts
    description: 'Access: create, edit, list, and manage posts.'
  - name: Promotions
    description: 'Access: promotions, trials, and bundles.'
  - name: Users
    description: 'Access: user profiles, subscriptions, and actions.'
  - name: Vault
    description: 'Access: vault folders, media, and management.'
  - name: Upload
    description: 'Access: media upload and processing.'
  - name: Self
    description: 'Access: linked account profile and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: Webhook event formats, including OnlyFans activity events.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v3/access/stories/highlights/:highlightId:
    get:
      tags:
        - Stories
      summary: Get story highlight
      description: |-
        Get a story highlight.

        **Required scope:** `stories:read`
      operationId: access.stories.highlights.get
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account to use. The user must have shared it with your
            app. A missing account returns `linked_account_required`; an account
            outside your access returns `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
        - schema:
            type: string
            pattern: ^\d+$
          required: true
          name: highlightId
          in: path
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                  userId:
                    type: number
                  title:
                    type: string
                  cover:
                    type: string
                  coverStoryId:
                    type: number
                  createdAt:
                    type: string
                  storiesCount:
                    type: number
                  stories:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        userId:
                          type: number
                        user:
                          type: object
                          properties:
                            id:
                              type: number
                            username:
                              type: string
                            name:
                              type: string
                            displayName:
                              type: string
                              nullable: true
                            isVerified:
                              type: boolean
                              nullable: true
                            avatar:
                              type: string
                              nullable: true
                            avatarThumbs:
                              type: object
                              nullable: true
                              additionalProperties:
                                type: string
                            isDeleted:
                              type: boolean
                            isActive:
                              type: boolean
                          required:
                            - id
                            - username
                            - name
                        isReady:
                          type: boolean
                        hasPost:
                          type: boolean
                        isWatched:
                          type: boolean
                        media:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              type:
                                type: string
                              convertedToVideo:
                                type: boolean
                              canView:
                                type: boolean
                              hasError:
                                type: boolean
                              createdAt:
                                type: string
                                nullable: true
                              isReady:
                                type: boolean
                              duration:
                                type: number
                              hasCustomPreview:
                                type: boolean
                              videoSources:
                                type: object
                                additionalProperties:
                                  anyOf:
                                    - type: string
                                    - nullable: true
                                    - nullable: true
                              files:
                                type: object
                                properties:
                                  full:
                                    type: object
                                    properties:
                                      url:
                                        type: string
                                        nullable: true
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                      sources:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            url:
                                              type: string
                                            width:
                                              type: number
                                            height:
                                              type: number
                                            type:
                                              type: string
                                          required:
                                            - url
                                    required:
                                      - sources
                                  thumb:
                                    type: object
                                    nullable: true
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                    required:
                                      - url
                                  preview:
                                    anyOf:
                                      - type: object
                                        properties:
                                          url:
                                            type: string
                                          width:
                                            type: number
                                          height:
                                            type: number
                                          size:
                                            type: number
                                          options:
                                            type: array
                                            items:
                                              type: object
                                              properties:
                                                url:
                                                  type: string
                                                width:
                                                  type: number
                                                height:
                                                  type: number
                                                type:
                                                  type: string
                                              required:
                                                - url
                                        required:
                                          - url
                                          - options
                                      - type: object
                                        properties:
                                          url:
                                            type: string
                                          width:
                                            type: number
                                          height:
                                            type: number
                                          size:
                                            type: number
                                        required:
                                          - url
                                      - nullable: true
                                  squarePreview:
                                    type: object
                                    nullable: true
                                    properties:
                                      url:
                                        type: string
                                      width:
                                        type: number
                                      height:
                                        type: number
                                      size:
                                        type: number
                                    required:
                                      - url
                                required:
                                  - full
                            required:
                              - id
                              - type
                              - convertedToVideo
                              - canView
                              - hasError
                              - isReady
                        createdAt:
                          type: string
                          nullable: true
                        question:
                          nullable: true
                        viewers:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              username:
                                type: string
                                nullable: true
                              name:
                                type: string
                                nullable: true
                              displayName:
                                type: string
                                nullable: true
                              isVerified:
                                type: boolean
                                nullable: true
                              avatar:
                                type: string
                                nullable: true
                              avatarThumbs:
                                type: object
                                nullable: true
                                additionalProperties:
                                  type: string
                              isStoryLiked:
                                type: boolean
                              isStoryBlockedUser:
                                type: boolean
                              canLookStory:
                                type: boolean
                              canCommentStory:
                                type: boolean
                              hasNotViewedStory:
                                type: boolean
                            required:
                              - id
                        canLike:
                          type: boolean
                        isLiked:
                          type: boolean
                      required:
                        - id
                        - userId
                        - isReady
                        - media
                required:
                  - id
                  - userId
                  - title
                  - cover
                  - coverStoryId
                  - createdAt
                  - storiesCount
                  - stories
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  securitySchemes:
    ExternalOAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Link access token for one Sandbox, Test, or Live authorization.
    LinkedAccountId:
      type: apiKey
      name: x-linked-account-id
      in: header
      description: >-
        Selects one of the authorization's linked accounts via the
        x-linked-account-id header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.