> ## 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.

# Account settings

> Get account settings for the linked account.

**Required scope:** `profile:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/settings
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/settings:
    get:
      tags:
        - Self
      summary: Account settings
      description: |-
        Get account settings for the linked account.

        **Required scope:** `profile:read`
      operationId: access.settings.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
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  activityHubAllowed:
                    type: boolean
                  activityHubTokens:
                    type: array
                    items: {}
                  appOtp:
                    type: boolean
                  avatarHeaderConverterUpload:
                    type: boolean
                  blockedCountries:
                    type: array
                    items:
                      type: string
                  blockedIps:
                    type: array
                    items: {}
                  blockedStates:
                    type: array
                    items: {}
                  bundleMaxPrice:
                    type: number
                  canAcceptMessageOnlyFromFriends:
                    type: boolean
                  canAddPhone:
                    type: boolean
                  canAddSubscriberByBundle:
                    type: object
                    properties:
                      discounts:
                        type: object
                        properties:
                          '0':
                            type: string
                          '5':
                            type: string
                          '10':
                            type: string
                          '15':
                            type: string
                          '20':
                            type: string
                          '25':
                            type: string
                          '30':
                            type: string
                          '35':
                            type: string
                          '40':
                            type: string
                          '45':
                            type: string
                          '50':
                            type: string
                        additionalProperties: true
                        required:
                          - '0'
                          - '10'
                          - '15'
                          - '20'
                          - '25'
                          - '30'
                          - '35'
                          - '40'
                          - '45'
                          - '5'
                          - '50'
                      durations:
                        type: object
                        properties:
                          '3':
                            type: string
                          '6':
                            type: string
                          '12':
                            type: string
                        additionalProperties: true
                        required:
                          - '12'
                          - '3'
                          - '6'
                    additionalProperties: true
                    required:
                      - discounts
                      - durations
                  canMakeProfileLinks:
                    type: boolean
                  canSocialsConnect:
                    type: boolean
                  changeEmailStep:
                    type: 'null'
                  changelogUpdates:
                    type: number
                  commentsOnlyForPayers:
                    type: boolean
                  confirmEmailSentAt:
                    type: string
                  coStreamingRequestFrom:
                    type: string
                  creatorsCommentsOnlyForFriends:
                    type: boolean
                  disableSubscribesOffers:
                    type: boolean
                  faceOtp:
                    type: boolean
                  forceFaceOtp:
                    type: boolean
                  hasPaidPosts:
                    type: boolean
                  hasPassword:
                    type: boolean
                  hideAfterMassMessages:
                    type: boolean
                  importantSubscriptionNotifications:
                    type: boolean
                  isAutoFollowBack:
                    type: boolean
                  isCoStreamingAllowed:
                    type: boolean
                  isDeleteInitiated:
                    type: boolean
                  isDrmEnabled:
                    type: boolean
                  isEmailNotificationsEnabled:
                    type: boolean
                  isMonthlyNewsletters:
                    type: boolean
                  isOldLoginRedirect:
                    type: boolean
                  isOpenseaConnected:
                    type: boolean
                  isOtpAppConnected:
                    type: boolean
                  isPrivate:
                    type: boolean
                  isSuggestionsOptOut:
                    type: boolean
                  isTelegramConnected:
                    type: boolean
                  lastSubscriptionExpiredAt:
                    type: 'null'
                  lifeTimeEmailCode:
                    type: 'null'
                  muteTagsInChats:
                    type: boolean
                  muteTagsInPosts:
                    type: boolean
                  muteTagsInStories:
                    type: boolean
                  muteTagsInStreams:
                    type: boolean
                  newEmail:
                    type: 'null'
                  notifyOnAllMentions:
                    type: boolean
                  phoneLast4:
                    type: 'null'
                  phoneOtp:
                    type: boolean
                  recommenderReward:
                    anyOf:
                      - type: 'null'
                      - type: string
                  replyOnSubscribe:
                    type: boolean
                  requireFaceIdForPayoutUpdate:
                    type: boolean
                  sendAwardsTop1:
                    type: boolean
                  sendAwardsTop5:
                    type: boolean
                  shouldReceiveLessNotifications:
                    type: boolean
                  showFriendsToSubscribers:
                    type: boolean
                  showFullTextInEmailNotify:
                    type: boolean
                  showPostsTips:
                    type: boolean
                  showSubscribesOffers:
                    type: boolean
                  socialsConnects:
                    type: array
                    items:
                      type: object
                      properties:
                        accountId:
                          type: string
                        date:
                          type: string
                        email:
                          type: string
                        id:
                          type: number
                        name:
                          type: string
                        provider:
                          type: string
                      additionalProperties: true
                      required:
                        - accountId
                        - date
                        - email
                        - id
                        - name
                        - provider
                  streamingMuxDirectKey:
                    type: string
                  streamingMuxKey:
                    type: 'null'
                  streamingMuxKeyExpiredAt:
                    type: 'null'
                  streamingMuxServer:
                    anyOf:
                      - type: 'null'
                      - type: string
                  streamingObsKey:
                    anyOf:
                      - type: 'null'
                      - type: string
                  streamingObsServer:
                    anyOf:
                      - type: 'null'
                      - type: string
                  streamingRtmpKey:
                    type: string
                  streamingRtmpServer:
                    type: string
                  strongOtp:
                    type: boolean
                  unfollowAutoFollowBack:
                    type: boolean
                additionalProperties: true
                required:
                  - activityHubAllowed
                  - activityHubTokens
                  - appOtp
                  - avatarHeaderConverterUpload
                  - blockedCountries
                  - blockedIps
                  - blockedStates
                  - bundleMaxPrice
                  - canAcceptMessageOnlyFromFriends
                  - canAddPhone
                  - canAddSubscriberByBundle
                  - canMakeProfileLinks
                  - canSocialsConnect
                  - changeEmailStep
                  - changelogUpdates
                  - commentsOnlyForPayers
                  - confirmEmailSentAt
                  - coStreamingRequestFrom
                  - creatorsCommentsOnlyForFriends
                  - disableSubscribesOffers
                  - faceOtp
                  - forceFaceOtp
                  - hasPaidPosts
                  - hasPassword
                  - hideAfterMassMessages
                  - importantSubscriptionNotifications
                  - isAutoFollowBack
                  - isCoStreamingAllowed
                  - isDeleteInitiated
                  - isDrmEnabled
                  - isEmailNotificationsEnabled
                  - isMonthlyNewsletters
                  - isOldLoginRedirect
                  - isOpenseaConnected
                  - isOtpAppConnected
                  - isPrivate
                  - isSuggestionsOptOut
                  - isTelegramConnected
                  - lastSubscriptionExpiredAt
                  - lifeTimeEmailCode
                  - muteTagsInChats
                  - muteTagsInPosts
                  - muteTagsInStories
                  - muteTagsInStreams
                  - newEmail
                  - notifyOnAllMentions
                  - phoneLast4
                  - phoneOtp
                  - recommenderReward
                  - replyOnSubscribe
                  - requireFaceIdForPayoutUpdate
                  - sendAwardsTop1
                  - sendAwardsTop5
                  - shouldReceiveLessNotifications
                  - showFriendsToSubscribers
                  - showFullTextInEmailNotify
                  - showPostsTips
                  - showSubscribesOffers
                  - socialsConnects
                  - streamingMuxDirectKey
                  - streamingMuxKey
                  - streamingMuxKeyExpiredAt
                  - streamingMuxServer
                  - streamingObsKey
                  - streamingObsServer
                  - streamingRtmpKey
                  - streamingRtmpServer
                  - strongOtp
                  - unfollowAutoFollowBack
        '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.