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

# Get automation provider settings

> List the platform-side automation settings stored per social account, such as the Instagram icebreakers or persistent menu we manage for you. Paginate with `offset` and `limit` (default 10). The response always carries the full `total`.



## OpenAPI

````yaml https://api.bundle.social/swagger-json get /api/v1/automation-provider-settings
openapi: 3.0.2
info:
  title: bundle.social API
  description: >-
    REST API for social media management. Perfect for AI assistants, GPTs,
    automation tools, and integrations. Post to 14+ platforms including Twitter,
    Instagram, Facebook, LinkedIn, TikTok, Pinterest, Reddit, Discord, Slack,
    YouTube, Mastodon, Bluesky, Threads, and Google Business. Schedule posts,
    manage content, analyze performance, and automate your social media workflow
    across all platforms.
  version: 1.0.0
  contact:
    email: contact@bundle.social
  termsOfService: https://bundle.social/terms
servers:
  - url: https://api.bundle.social
  - url: http://localhost:3001
security:
  - ApiKeyAuth: []
tags:
  - name: app
  - name: organization
  - name: team
  - name: socialAccount
  - name: upload
  - name: post
  - name: postImport
  - name: analytics
  - name: comment
  - name: conversation
    description: >-
      Read and reply to Instagram and Facebook direct message conversations,
      react to messages, and send private replies to comments.
  - name: automation
    description: >-
      Build, publish and monitor automation flows that react to incoming
      messages and comments, plus the per-account provider settings they rely
      on.
  - name: misc
  - name: postCSV
paths:
  /api/v1/automation-provider-settings:
    get:
      tags:
        - automation
      summary: Get automation provider settings
      description: >-
        List the platform-side automation settings stored per social account,
        such as the Instagram icebreakers or persistent menu we manage for you.
        Paginate with `offset` and `limit` (default 10). The response always
        carries the full `total`.
      operationId: automation.getProviderSettings
      parameters:
        - name: teamId
          in: query
          required: true
          schema:
            type: string
        - name: platform
          in: query
          schema:
            type: string
            enum:
              - INSTAGRAM
              - FACEBOOK
              - TIKTOK
        - name: socialAccountId
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
            enum:
              - FACEBOOK_PERSISTENT_MENU
              - INSTAGRAM_ICE_BREAKERS
        - name: status
          in: query
          schema:
            type: string
            enum:
              - DRAFT
              - SYNCED
              - SYNC_FAILED
              - DISABLED
        - name: offset
          in: query
          schema:
            default: 0
            type: number
            nullable: true
        - name: limit
          in: query
          schema:
            default: 10
            type: number
            nullable: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        teamId:
                          type: string
                        organizationId:
                          type: string
                          nullable: true
                        platform:
                          type: string
                          enum:
                            - INSTAGRAM
                            - FACEBOOK
                            - TIKTOK
                        socialAccountId:
                          type: string
                        type:
                          type: string
                          enum:
                            - FACEBOOK_PERSISTENT_MENU
                            - INSTAGRAM_ICE_BREAKERS
                        status:
                          type: string
                          enum:
                            - DRAFT
                            - SYNCED
                            - SYNC_FAILED
                            - DISABLED
                        config:
                          default: {}
                          oneOf:
                            - type: object
                              properties:
                                getStartedPayload:
                                  type: string
                                  minLength: 1
                                  maxLength: 1000
                                composerInputDisabled:
                                  type: boolean
                                items:
                                  type: array
                                  items:
                                    discriminator:
                                      propertyName: type
                                    oneOf:
                                      - type: object
                                        properties:
                                          title:
                                            type: string
                                            minLength: 1
                                          type:
                                            type: string
                                            enum:
                                              - POSTBACK
                                          payload:
                                            type: string
                                            minLength: 1
                                            maxLength: 1000
                                          url:
                                            type: string
                                        required:
                                          - title
                                          - type
                                          - payload
                                        additionalProperties: false
                                      - type: object
                                        properties:
                                          title:
                                            type: string
                                            minLength: 1
                                          type:
                                            type: string
                                            enum:
                                              - URL
                                          payload:
                                            type: string
                                          url:
                                            type: string
                                            format: uri
                                        required:
                                          - title
                                          - type
                                          - url
                                        additionalProperties: false
                                  maxItems: 3
                              additionalProperties: false
                            - type: object
                              properties:
                                iceBreakers:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      question:
                                        type: string
                                        minLength: 1
                                      payload:
                                        type: string
                                        minLength: 1
                                        maxLength: 1000
                                    required:
                                      - question
                                      - payload
                                    additionalProperties: false
                                  maxItems: 4
                              additionalProperties: false
                        providerResponse:
                          type: object
                          properties: {}
                          additionalProperties:
                            nullable: true
                          nullable: true
                        lastSyncedAt:
                          type: string
                          format: date-time
                          nullable: true
                        lastSyncError:
                          type: object
                          properties:
                            code:
                              type: string
                              nullable: true
                            message:
                              type: string
                              nullable: true
                            retryable:
                              type: boolean
                              nullable: true
                          additionalProperties:
                            nullable: true
                          nullable: true
                        createdAt:
                          type: string
                          format: date-time
                          nullable: true
                        updatedAt:
                          type: string
                          format: date-time
                          nullable: true
                        socialAccount:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                                - TIKTOK
                                - YOUTUBE
                                - INSTAGRAM
                                - FACEBOOK
                                - TWITTER
                                - THREADS
                                - LINKEDIN
                                - PINTEREST
                                - REDDIT
                                - MASTODON
                                - DISCORD
                                - SLACK
                                - BLUESKY
                                - GOOGLE_BUSINESS
                                - SNAPCHAT
                            teamId:
                              type: string
                            username:
                              type: string
                              nullable: true
                            displayName:
                              type: string
                              nullable: true
                            bio:
                              type: string
                              nullable: true
                            avatarUrl:
                              type: string
                              nullable: true
                            externalId:
                              type: string
                              nullable: true
                            providerPageId:
                              type: string
                              nullable: true
                            userUsername:
                              type: string
                              nullable: true
                            userDisplayName:
                              type: string
                              nullable: true
                            userEmail:
                              type: string
                              nullable: true
                            userId:
                              type: string
                              nullable: true
                            channels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                    nullable: true
                                  username:
                                    type: string
                                    nullable: true
                                  address:
                                    type: string
                                    nullable: true
                                  avatarUrl:
                                    type: string
                                    nullable: true
                                  webhook:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                        nullable: true
                                      name:
                                        type: string
                                        nullable: true
                                      avatar:
                                        type: string
                                        nullable: true
                                      url:
                                        type: string
                                        nullable: true
                                    nullable: true
                                  metadata:
                                    type: object
                                    properties:
                                      allowImages:
                                        type: boolean
                                        nullable: true
                                      allowVideos:
                                        type: boolean
                                        nullable: true
                                      allowGalleries:
                                        type: boolean
                                        nullable: true
                                      linkFlairEnabled:
                                        type: boolean
                                        nullable: true
                                      facebookPageId:
                                        type: string
                                        nullable: true
                                    nullable: true
                                required:
                                  - id
                              nullable: true
                            mastodonServerId:
                              type: string
                              nullable: true
                            instagramConnectionMethod:
                              type: string
                              enum:
                                - FACEBOOK
                                - INSTAGRAM
                              nullable: true
                            twitterSubType:
                              type: string
                              enum:
                                - none
                                - basic
                                - premium
                                - premium_plus
                              nullable: true
                            isTiktokBusinessAccount:
                              type: boolean
                              nullable: true
                            disconnectedCheckTryAt:
                              type: string
                              format: date-time
                              nullable: true
                            deleteOn:
                              type: string
                              format: date-time
                              nullable: true
                            messagingStatus:
                              default: DISABLED
                              type: string
                              enum:
                                - DISABLED
                                - ENABLED
                                - DISABLE_PENDING
                            messagingStatusUpdatedAt:
                              type: string
                              format: date-time
                              nullable: true
                            messagingLastError:
                              type: string
                              nullable: true
                            createdAt:
                              type: string
                              format: date-time
                              nullable: true
                            updatedAt:
                              type: string
                              format: date-time
                              nullable: true
                            deletedAt:
                              type: string
                              format: date-time
                              nullable: true
                          required:
                            - id
                            - type
                            - teamId
                            - createdAt
                            - updatedAt
                      required:
                        - id
                        - teamId
                        - platform
                        - socialAccountId
                        - type
                        - status
                        - createdAt
                        - updatedAt
                  total:
                    type: number
                required:
                  - items
                  - total
        '400':
          description: '400'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          enum:
                            - invalid_type
                            - invalid_literal
                            - custom
                            - invalid_union
                            - invalid_union_discriminator
                            - invalid_enum_value
                            - unrecognized_keys
                            - invalid_arguments
                            - invalid_return_type
                            - invalid_date
                            - invalid_string
                            - too_small
                            - too_big
                            - invalid_intersection_types
                            - not_multiple_of
                            - not_finite
                          nullable: true
                        message:
                          type: string
                        path:
                          type: array
                          items:
                            oneOf:
                              - type: string
                              - type: number
                          nullable: true
                      required:
                        - message
                    nullable: true
                required:
                  - message
        '401':
          description: '401'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                required:
                  - message
        '403':
          description: '403'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                required:
                  - message
        '404':
          description: '404'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                required:
                  - message
        '429':
          description: '429'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                required:
                  - message
        '500':
          description: '500'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                required:
                  - message
        '502':
          description: '502'
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    nullable: true
                  message:
                    type: string
                required:
                  - message
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: x-api-key
      in: header

````