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

# Get a collaboration

> Returns a collaboration that is accessible to the organization.



## OpenAPI

````yaml /openapi/partner.yaml get /collaborations/{collaborationId}
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:
  /collaborations/{collaborationId}:
    get:
      tags:
        - Collaborations
      summary: Get a collaboration
      description: Returns a collaboration that is accessible to the organization.
      operationId: getPartnerCollaboration
      parameters:
        - $ref: '#/components/parameters/CollaborationId'
        - name: include
          in: query
          description: Set to `campaign` to include campaign details.
          schema:
            type: string
            enum:
              - campaign
      responses:
        '200':
          description: The collaboration.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/PartnerCollaboration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    CollaborationId:
      name: collaborationId
      in: path
      required: true
      schema:
        type: string
  schemas:
    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'
    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'
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
  responses:
    BadRequest:
      $ref: '#/components/responses/Error400'
    Unauthorized:
      $ref: '#/components/responses/Error401'
    Forbidden:
      $ref: '#/components/responses/Error403'
    NotFound:
      $ref: '#/components/responses/Error404'
    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'
    Error404:
      description: Resource not found or not accessible to this organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  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 Partner workspace.

````