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

# List placements

> Returns scheduled content for the organization. Related creator, channel, collaboration, and campaign objects are opt-in through `include`.



## OpenAPI

````yaml /openapi/partner.yaml get /placements
openapi: 3.1.0
info:
  title: Passionfroot Partner API
  version: 1.0.0-alpha
  description: >
    Access a brand workspace's creators, collaborations, placements, proposals,
    and conversations.

    The API is in alpha. Every operation is restricted to the organization that
    owns the API key.
servers:
  - url: https://workspace.passionfroot.me/api/v1
security:
  - bearerAuth: []
tags:
  - name: Placements
  - name: Creators
  - name: Collaborations
  - name: Conversations
  - name: Proposals
paths:
  /placements:
    get:
      tags:
        - Placements
      summary: List placements
      description: >-
        Returns scheduled content for the organization. Related creator,
        channel, collaboration, and campaign objects are opt-in through
        `include`.
      operationId: listPartnerPlacements
      parameters:
        - $ref: '#/components/parameters/StartDate'
        - $ref: '#/components/parameters/EndDate'
        - $ref: '#/components/parameters/MetricsUpdatedAfter'
        - $ref: '#/components/parameters/MetricsUpdatedBefore'
        - name: collaborationId
          in: query
          description: Return placements belonging to this collaboration.
          schema:
            type: string
        - $ref: '#/components/parameters/Status'
        - name: include
          in: query
          description: >-
            Comma-separated expansions. Supported values are `creator`,
            `creator.channels`, `collaboration`, and `collaboration.campaign`.
          schema:
            type: string
          example: creator.channels,collaboration.campaign
        - $ref: '#/components/parameters/Limit250'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of placements.
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerPlacementPage'
              examples:
                default:
                  value:
                    data:
                      - id: plc_123
                        creatorId: creator_abc
                        creatorName: Jane Creator
                        collaborationId: collab_xyz
                        date: '2026-09-15T00:00:00.000Z'
                        name: Fall launch – Instagram Reel
                        status: confirmed
                        platform: instagram
                        postType: Reel
                        url: https://instagram.com/p/example
                        viewCount: 15000
                        likeCount: 1200
                        commentCount: 45
                        shareCount: 30
                        metricsLastUpdatedAt: '2026-09-20T14:30:00.000Z'
                        priceCents: 15750
                        usdPriceCents: 15750
                        currency: USD
                    pagination:
                      nextCursor: plc_122
                      hasMore: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    StartDate:
      name: startDate
      in: query
      description: Include placements on or after this calendar date.
      schema:
        type: string
        format: date
    EndDate:
      name: endDate
      in: query
      description: Include placements on or before this calendar date.
      schema:
        type: string
        format: date
    MetricsUpdatedAfter:
      name: metricsUpdatedAfter
      in: query
      description: >-
        Include placements whose reported metrics were updated on or after this
        date or timestamp.
      schema:
        type: string
    MetricsUpdatedBefore:
      name: metricsUpdatedBefore
      in: query
      description: >-
        Include placements whose reported metrics were updated on or before this
        date or timestamp.
      schema:
        type: string
    Status:
      name: status
      in: query
      description: Comma-separated statuses.
      schema:
        type: string
      example: confirmed,pending
    Limit250:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 250
        default: 50
    Cursor:
      name: cursor
      in: query
      description: Opaque cursor returned by the previous page.
      schema:
        type: string
  headers:
    RateLimit:
      description: Per-key limit, remaining requests, and seconds until reset.
      schema:
        type: string
        example: limit=2, remaining=1, reset=1
    RateLimitPolicy:
      description: Per-key rate-limit policy.
      schema:
        type: string
        example: 2;w=1
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
  schemas:
    PartnerPlacementPage:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PartnerPlacement'
        pagination:
          $ref: '#/components/schemas/Pagination'
    PartnerPlacement:
      type: object
      required:
        - id
        - creatorId
        - creatorName
        - collaborationId
        - date
        - name
        - status
        - platform
        - postType
        - url
        - viewCount
        - likeCount
        - commentCount
        - shareCount
        - metricsLastUpdatedAt
        - priceCents
        - usdPriceCents
        - currency
      properties:
        id:
          type: string
        creatorId:
          type: string
        creatorName:
          type: string
          deprecated: true
        collaborationId:
          type:
            - string
            - 'null'
        date:
          type: string
          format: date-time
        name:
          type: string
        status:
          type: string
          enum:
            - pending
            - confirmed
            - cancelled
        platform:
          type:
            - string
            - 'null'
        postType:
          type:
            - string
            - 'null'
        url:
          type:
            - string
            - 'null'
          format: uri
        viewCount:
          type:
            - integer
            - 'null'
        likeCount:
          type:
            - integer
            - 'null'
        commentCount:
          type:
            - integer
            - 'null'
        shareCount:
          type:
            - integer
            - 'null'
        metricsLastUpdatedAt:
          type:
            - string
            - 'null'
          format: date-time
        priceCents:
          type:
            - integer
            - 'null'
        usdPriceCents:
          type:
            - integer
            - 'null'
        currency:
          type:
            - string
            - 'null'
        creator:
          $ref: '#/components/schemas/Creator'
        collaboration:
          anyOf:
            - $ref: '#/components/schemas/PartnerCollaboration'
            - type: 'null'
    Pagination:
      type: object
      required:
        - hasMore
      properties:
        nextCursor:
          type:
            - string
            - 'null'
        hasMore:
          type: boolean
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
    Creator:
      type: object
      required:
        - id
        - displayName
        - country
        - note
        - labels
      properties:
        id:
          type: string
        displayName:
          type: string
        country:
          type:
            - string
            - 'null'
        note:
          type:
            - string
            - 'null'
          description: Plain-text private workspace note.
        labels:
          type: array
          items:
            $ref: '#/components/schemas/Label'
        channels:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
    PartnerCollaboration:
      type: object
      required:
        - id
        - name
        - creatorId
        - campaignId
        - status
        - priceCents
        - usdPriceCents
        - currency
        - createdAt
        - statusUpdatedAt
      properties:
        id:
          type: string
        name:
          type: string
        creatorId:
          type: string
        campaignId:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending
            - confirmed
            - cancelled
        priceCents:
          type:
            - integer
            - 'null'
        usdPriceCents:
          type:
            - integer
            - 'null'
        currency:
          type: string
        createdAt:
          type: string
          format: date-time
        statusUpdatedAt:
          type: string
          format: date-time
        campaign:
          anyOf:
            - $ref: '#/components/schemas/Campaign'
            - type: 'null'
    Label:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
        name:
          type: string
        color:
          type: string
        position:
          type: string
    Channel:
      type: object
      required:
        - id
        - title
        - platformType
      properties:
        id:
          type: string
        title:
          type: string
        url:
          type:
            - string
            - 'null'
          format: uri
        platformType:
          type: string
        metrics:
          anyOf:
            - $ref: '#/components/schemas/Metrics'
            - type: 'null'
    Campaign:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type:
            - string
            - 'null'
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        budgetAmountCents:
          type:
            - integer
            - 'null'
        budgetCurrency:
          type:
            - string
            - 'null'
    Metrics:
      type: object
      properties:
        reach:
          type:
            - integer
            - 'null'
        views:
          type:
            - integer
            - 'null'
        engagement:
          type:
            - integer
            - 'null'
        engagementRate:
          type:
            - number
            - 'null'
        metricsUpdatedAt:
          type: string
          format: date-time
  responses:
    BadRequest:
      $ref: '#/components/responses/Error400'
    Unauthorized:
      $ref: '#/components/responses/Error401'
    Forbidden:
      $ref: '#/components/responses/Error403'
    TooManyRequests:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Too many requests, please try again later.
    Error400:
      description: Invalid parameters or body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error401:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: The key lacks access or the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Passionfroot API key
      description: Create an API key from Settings → API in an approved Partner workspace.

````