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

# List Brand destinations

> List a Brand's publishing-destination commitments.



## OpenAPI

````yaml /openapi.json get /v1/brands/{brandId}/destinations
openapi: 3.1.0
info:
  title: Sigmora API
  version: 1.0.0
  description: >-
    The priced, versioned public API. Every call authenticates with a workspace
    API key (`Authorization: Bearer sk_live_…`), names the project it files its
    output under, and reports what it cost. `GET /v1/capabilities` answers what
    this deployment can serve right now and at what price; anything it reports
    as unavailable answers 503 `capability_unavailable` rather than 404.
servers:
  - url: https://api.sigmora.org
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: What this deployment serves, what it costs, and what you have spent.
  - name: Projects
    description: The container every capability files its output under.
  - name: Sessions
    description: Durable bindings between an external harness session and one project.
  - name: Assets
    description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.'
  - name: Jobs
    description: Where every asynchronous capability is collected, whatever produced it.
  - name: Text
    description: Scripts, research, articles, translation and question sets.
  - name: Video
    description: Narrated renders, footage edits, shorts and moment selection.
  - name: UGC
    description: >-
      Creator-led vertical videos: AI creators, their faces and voices, frames
      and clips.
  - name: Editing
    description: >-
      Sigma, the editor: conversational turns, granular transcript edits,
      approvals.
  - name: 3D
    description: Animated 3D renders from a description or a photograph.
  - name: Image
    description: Thumbnails, sized for the platform they are posted to.
  - name: Audio
    description: Generated music and audio engineering in Audiotool projects.
  - name: Publishing
    description: Connected destinations and queued posts.
  - name: Webhooks
    description: Signed, at-least-once delivery of job and publishing events.
  - name: Workflows
    description: Context snapshots, versioned recipes, costed proposals and their runs.
  - name: Agents
    description: Describe an outcome and let a bounded plan of capabilities run.
  - name: Research
    description: >-
      Observed hooks, creator outliers and production briefs from saved
      analyses.
  - name: Themes
    description: The canonical content taxonomy, and the niche profiles built on it.
  - name: Signals
    description: Evidence-backed trends and scored viral content.
  - name: Discovery
    description: Compiled watch plans, their runs, and source freshness.
  - name: Watchlist
    description: 'Accounts you watch: their usual reach and the posts that beat it.'
  - name: Performance
    description: Your own channels' videos against their usual, and fixes to live videos.
  - name: Autopilot
    description: The durable trend-to-distribution workflow and its checkpoints.
  - name: Campaigns
    description: Distribution records shared by the API, the dashboard and autopilot.
  - name: Brands
    description: >-
      Cross-platform identities with their own voice, rules and publishing
      commitments.
  - name: Products
    description: What a campaign promotes.
paths:
  /v1/brands/{brandId}/destinations:
    get:
      tags:
        - Brands
      summary: List Brand destinations
      description: List a Brand's publishing-destination commitments.
      operationId: getBrandsByBrandIdDestinations
      parameters:
        - name: brandId
          in: path
          required: true
          description: A Brand id, from GET /v1/brands.
          schema:
            type: string
            minLength: 1
            maxLength: 200
            description: A Brand id, from GET /v1/brands.
            examples:
              - brd_4b81
        - name: includeArchived
          in: query
          required: false
          description: Set true to include archived commitments; defaults to false.
          schema:
            default: false
            description: Set true to include archived commitments; defaults to false.
            type: boolean
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  destinations:
                    type: array
                    items:
                      $ref: '#/components/schemas/BrandDestination'
                      description: >-
                        One Brand × connected account × content-lane consistency
                        commitment.
                required:
                  - success
                  - destinations
                additionalProperties: {}
        '400':
          description: 'Failure. `code` is one of: invalid_request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Failure. `code` is one of: unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Failure. `code` is one of: forbidden, origin_not_allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Failure. `code` is one of: not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Failure. `code` is one of: rate_limited.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Failure. `code` is one of: upstream_error, internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Failure. `code` is one of: capability_unavailable,
            upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BrandDestination:
      type: object
      properties:
        id:
          type: string
        contentBrandId:
          type: string
        connectedAccountId:
          type: string
        platform:
          type: string
          enum:
            - tiktok
            - instagram
            - youtube
            - x
            - linkedin
            - threads
            - reddit
            - mastodon
            - facebook
            - substack
            - whatsapp
            - telegram
            - bluesky
            - snapchat
            - medium
            - quora
            - nextdoor
            - rumble
            - xiaohongshu
            - pinterest
            - tumblr
            - discord
            - vimeo
            - devto
            - hashnode
            - google_business
            - lemmy
            - yelp
            - yellowpages
            - bing_places
            - apple_business
        lane:
          type: string
          enum:
            - long-form
            - short-form
            - image
            - text
            - thread
            - audio
        status:
          type: string
          enum:
            - active
            - paused
            - archived
        schedule:
          $ref: '#/components/schemas/DestinationSchedule'
          description: >-
            The publishing cadence a Brand commits to on one destination: how
            many posts, on which days, in which time windows.
        contentFormats:
          type: array
          items:
            type: string
            enum:
              - talking-head
              - ai-avatar
              - voiceover-faceless
              - screen-tutorial
              - product-demo
              - interview-podcast-clip
              - repurposed-clip
              - motion-graphics
              - static-carousel
        automationLevel:
          type: string
          enum:
            - remind-only
            - suggest-ideas
            - prepare-drafts
            - render-for-review
            - schedule-after-approval
            - full-auto
        reminders:
          $ref: '#/components/schemas/ConsistencyReminderPolicy'
          description: >-
            When Sigmora may remind the workspace owner that a destination is
            falling behind its schedule.
        version:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
        effectiveFrom:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - contentBrandId
        - connectedAccountId
        - platform
        - lane
        - status
        - schedule
        - contentFormats
        - automationLevel
        - reminders
        - version
        - effectiveFrom
        - createdAt
        - updatedAt
      additionalProperties: {}
      description: One Brand × connected account × content-lane consistency commitment.
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: >-
            Human-readable. Copy may change between releases — do not match on
            it.
        code:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - origin_not_allowed
            - not_found
            - conflict
            - payload_too_large
            - insufficient_credits
            - budget_capped
            - content_not_cleared
            - rate_limited
            - capability_unavailable
            - upstream_unavailable
            - upstream_error
            - internal_error
          description: Stable machine-readable cause. Branch on this.
        details:
          description: Optional structured context, e.g. the credits shortfall.
        requestId:
          type: string
          description: >-
            Identifies this request in our logs. Include it when you contact
            support.
        timestamp:
          type: string
          format: date-time
          description: When the failure was produced.
    DestinationSchedule:
      type: object
      properties:
        posts:
          type: integer
          minimum: 1
          maximum: 100
          description: >-
            Number of posts promised in each selected period, from 1 through
            100.
        period:
          type: string
          enum:
            - day
            - week
          description: >-
            Use `day` to apply the target on every active day, or `week` once
            per week.
        activeDays:
          minItems: 1
          maxItems: 7
          type: array
          items:
            type: integer
            minimum: 0
            maximum: 6
          description: Audience-local publishing days, where Sunday is 0 and Saturday is 6.
        maxPostsPerDay:
          type: integer
          minimum: 1
          maximum: 20
          description: >-
            Hard daily cap for this destination and content lane, from 1 through
            20.
        timezone:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            IANA timezone used to evaluate days and posting windows, for example
            `Africa/Nairobi`.
        postingWindows:
          minItems: 1
          maxItems: 14
          type: array
          items:
            type: object
            properties:
              startHour:
                type: integer
                minimum: 0
                maximum: 23
                description: Start hour in the audience timezone, from 0 through 23.
              endHour:
                type: integer
                minimum: 0
                maximum: 23
                description: >-
                  End hour in the audience timezone, from 0 through 23; it may
                  cross midnight.
              daysOfWeek:
                description: >-
                  Weekdays this window applies to, where Sunday is 0 and
                  Saturday is 6.
                maxItems: 7
                type: array
                items:
                  type: integer
                  minimum: 0
                  maximum: 6
            required:
              - startHour
              - endHour
          description: >-
            One or more audience-local time windows in which posts may be
            placed.
        minIntervalHours:
          type: number
          minimum: 0
          maximum: 168
          description: >-
            Minimum hours between posts on the same day; use 0 for no spacing
            floor.
      required:
        - posts
        - period
        - activeDays
        - maxPostsPerDay
        - timezone
        - postingWindows
        - minIntervalHours
      description: >-
        The publishing cadence a Brand commits to on one destination: how many
        posts, on which days, in which time windows.
    ConsistencyReminderPolicy:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether Sigmora may email the workspace owner about proven gaps.
        leadDays:
          type: integer
          minimum: 0
          maximum: 14
          description: >-
            How many calendar days before an uncovered commitment may trigger a
            reminder.
        cooldownHours:
          type: integer
          minimum: 6
          maximum: 336
          description: >-
            Minimum hours between reminders for this destination, from 6 through
            336.
        channels:
          minItems: 1
          maxItems: 1
          type: array
          items:
            type: string
            const: email
          description: Delivery channels to use; email is the only supported channel today.
        includeTrendIdeas:
          type: boolean
          description: >-
            Include matching ideas already present in the workspace backlog;
            this does not authorize paid research.
        includeDraftScript:
          type: boolean
          description: >-
            Include a script link when a suitable draft already exists; this
            does not generate one automatically.
        customInstructions:
          description: >-
            Optional reminder-brief guidance, up to 1,000 characters; it cannot
            override approval controls.
          type: string
          maxLength: 1000
      required:
        - enabled
        - leadDays
        - cooldownHours
        - channels
        - includeTrendIdeas
        - includeDraftScript
      description: >-
        When Sigmora may remind the workspace owner that a destination is
        falling behind its schedule.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A workspace API key.

````

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