---
title: "Get automation provider settings"
method: GET
path: "/api/v1/automation-provider-settings"
tags: ["automation"]
---

# Get automation provider settings

`GET /api/v1/automation-provider-settings`

## Request

- Base URL: `https://api.bundle.social`
- URL: `https://api.bundle.social/api/v1/automation-provider-settings`
- Auth: API key in header `x-api-key`

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

## Query parameters

- `teamId` string, required
- `platform` 'INSTAGRAM' | 'FACEBOOK' | 'TIKTOK'
- `socialAccountId` string
- `type` 'FACEBOOK_PERSISTENT_MENU' | 'INSTAGRAM_ICE_BREAKERS'
- `status` 'DRAFT' | 'SYNCED' | 'SYNC_FAILED' | 'DISABLED'
- `offset` number, nullable
- `limit` number, nullable

## Response `200`

200

- object
  - `items` object[], required
    - `id` string, required
    - `teamId` string, required
    - `organizationId` string, nullable
    - `platform` 'INSTAGRAM' | 'FACEBOOK' | 'TIKTOK', required
    - `socialAccountId` string, required
    - `type` 'FACEBOOK_PERSISTENT_MENU' | 'INSTAGRAM_ICE_BREAKERS', required
    - `status` 'DRAFT' | 'SYNCED' | 'SYNC_FAILED' | 'DISABLED', required
    - `config` union
      - object
        - `getStartedPayload` string
        - `composerInputDisabled` boolean
        - `items` union[]
          - union
            - object
              - …
            - object
              - …
      - object
        - `iceBreakers` object[]
          - `question` string, required
          - `payload` string, required
    - `providerResponse` object, nullable
    - `lastSyncedAt` string, date-time, nullable
    - `lastSyncError` object, nullable
      - `code` string, nullable
      - `message` string, nullable
      - `retryable` boolean, nullable
    - `createdAt` string, date-time, nullable, required
    - `updatedAt` string, date-time, nullable, required
    - `socialAccount` object
      - `id` string, required
      - `type` 'TIKTOK' | 'YOUTUBE' | 'INSTAGRAM' | 'FACEBOOK' | 'TWITTER' | 'THREADS' | 'LINKEDIN' | 'PINTEREST' | 'REDDIT' | 'MASTODON' | 'DISCORD' | 'SLACK' | 'BLUESKY' | 'GOOGLE_BUSINESS' | 'SNAPCHAT', required
      - `teamId` string, required
      - `username` string, nullable
      - `displayName` string, nullable
      - `bio` string, nullable
      - `avatarUrl` string, nullable
      - `externalId` string, nullable
      - `providerPageId` string, nullable
      - `userUsername` string, nullable
      - `userDisplayName` string, nullable
      - `userEmail` string, nullable
      - `userId` string, nullable
      - `channels` object[], nullable
        - `id` string, required
        - `name` string, nullable
        - `username` string, nullable
        - `address` string, nullable
        - `avatarUrl` string, nullable
        - `webhook` object, nullable
          - `id` string, nullable
          - `name` string, nullable
          - `avatar` string, nullable
          - `url` string, nullable
        - `metadata` object, nullable
          - `allowImages` boolean, nullable
          - `allowVideos` boolean, nullable
          - `allowGalleries` boolean, nullable
          - `linkFlairEnabled` boolean, nullable
          - `facebookPageId` string, nullable
      - `mastodonServerId` string, nullable
      - `instagramConnectionMethod` 'FACEBOOK' | 'INSTAGRAM', nullable
      - `twitterSubType` 'none' | 'basic' | 'premium' | 'premium_plus', nullable
      - `isTiktokBusinessAccount` boolean, nullable
      - `disconnectedCheckTryAt` string, date-time, nullable
      - `deleteOn` string, date-time, nullable
      - `messagingStatus` 'DISABLED' | 'ENABLED' | 'DISABLE_PENDING'
      - `messagingStatusUpdatedAt` string, date-time, nullable
      - `messagingLastError` string, nullable
      - `createdAt` string, date-time, nullable, required
      - `updatedAt` string, date-time, nullable, required
      - `deletedAt` string, date-time, nullable
  - `total` number, required

## Other responses

- `400`: 400
- `401`: 401
- `403`: 403
- `404`: 404
- `429`: 429
- `500`: 500
- `502`: 502
- `503`: 503
- `504`: 504

## Changes

- **2026-11-03** `fb6e4fbd8d2f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bundle/apis/bundle-social-api/changes/api/v1/automation-provider-settings/get.md)

---

[API](https://skmtc.dev/bundle/apis/bundle-social-api.md) - [All operations](https://skmtc.dev/bundle/apis/bundle-social-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bundle/apis/bundle-social-api/revisions/18efa1cb93a4?raw)