> ## 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 the creator's scheduled deliverables. All prices are creator earnings after Passionfroot fees and before taxes.



## OpenAPI

````yaml /openapi/creator.yaml get /placements
openapi: 3.1.0
info:
  title: Passionfroot Creator API
  version: 1.0.0-alpha
  description: >
    Access a creator's own partners, collaborations, placements, catalog,
    proposals, and conversations.

    The API is in alpha. Every operation is restricted to the creator account
    that owns the API key.
servers:
  - url: https://workspace.passionfroot.me/api/creators/v1
security:
  - bearerAuth: []
tags:
  - name: Placements
  - name: Partners
  - name: Collaborations
  - name: Conversations
  - name: Catalog
  - name: Requests
  - name: Proposals
paths:
  /placements:
    get:
      tags:
        - Placements
      summary: List placements
      description: >-
        Returns the creator's scheduled deliverables. All prices are creator
        earnings after Passionfroot fees and before taxes.
      operationId: listCreatorPlacements
      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 `partner` and
            `collaboration`.
          schema:
            type: string
          example: partner,collaboration
        - $ref: '#/components/parameters/Limit250'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of creator placements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatorPlacementPage'
              example:
                data:
                  - id: plc_123
                    partnerId: partner_xyz
                    collaborationId: collab_xyz
                    date: '2026-09-15T00:00:00.000Z'
                    name: Acme launch – Newsletter feature
                    status: confirmed
                    platform: newsletter
                    postType: Dedicated
                    url: https://example.com/acme-launch
                    viewCount: 15000
                    likeCount: 1200
                    commentCount: 45
                    shareCount: 30
                    metricsLastUpdatedAt: '2026-09-20T14:30:00.000Z'
                    priceCents: 142500
                    usdPriceCents: 142500
                    currency: USD
                    partner:
                      id: partner_xyz
                      name: Acme Corp
                      websiteUrl: https://acme.com
                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 date.
      schema:
        type: string
        format: date
    EndDate:
      name: endDate
      in: query
      description: Include placements on or before this 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
  schemas:
    CreatorPlacementPage:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CreatorPlacement'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CreatorPlacement:
      type: object
      required:
        - id
        - partnerId
        - collaborationId
        - date
        - name
        - status
        - platform
        - postType
        - url
        - viewCount
        - likeCount
        - commentCount
        - shareCount
        - metricsLastUpdatedAt
        - priceCents
        - usdPriceCents
        - currency
      properties:
        id:
          type: string
        partnerId:
          type:
            - string
            - 'null'
        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'
          description: >-
            Creator earnings for the placement after Passionfroot fees and
            before taxes.
        usdPriceCents:
          type:
            - integer
            - 'null'
        currency:
          type:
            - string
            - 'null'
        partner:
          anyOf:
            - $ref: '#/components/schemas/Partner'
            - type: 'null'
        collaboration:
          anyOf:
            - $ref: '#/components/schemas/CreatorCollaboration'
            - 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
    Partner:
      type: object
      required:
        - id
        - name
        - websiteUrl
      properties:
        id:
          type: string
        name:
          type: string
        websiteUrl:
          type:
            - string
            - 'null'
          format: uri
    CreatorCollaboration:
      type: object
      required:
        - id
        - name
        - partnerId
        - status
        - priceCents
        - usdPriceCents
        - currency
        - createdAt
        - statusUpdatedAt
      properties:
        id:
          type: string
        name:
          type: string
        partnerId:
          type: string
        status:
          type: string
          enum:
            - pending
            - confirmed
            - cancelled
        priceCents:
          type:
            - integer
            - 'null'
          description: Creator earnings after Passionfroot fees and before taxes.
        usdPriceCents:
          type:
            - integer
            - 'null'
        currency:
          type: string
        createdAt:
          type: string
          format: date-time
        statusUpdatedAt:
          type: string
          format: date-time
  responses:
    BadRequest:
      description: Invalid parameters or body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The key lacks access or the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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.
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Passionfroot API key
      description: Create an API key from Settings → API in an approved Creator workspace.

````