# Passionfroot API

> Build creator and brand workflows with the Passionfroot APIs.

- [Passionfroot API](https://docs.passionfroot.me/index.md): Build integrations for brand partners and creators.
- [Quickstart](https://docs.passionfroot.me/quickstart.md): Authenticate and make your first Passionfroot API request.
- [Authentication](https://docs.passionfroot.me/guides/authentication.md): Create, store, and send Passionfroot API keys safely.
- [Pagination](https://docs.passionfroot.me/guides/pagination.md): Traverse cursor-paginated collections without missing records.
- [Rate limits](https://docs.passionfroot.me/guides/rate-limits.md): Respect per-key and per-IP request limits.
- [Idempotency](https://docs.passionfroot.me/guides/idempotency.md): Retry supported write operations without creating duplicates.
- [List placements](https://docs.passionfroot.me/partner-reference/placements/list-placements.md): Returns scheduled content for the organization. Related creator, channel, collaboration, and campaign objects are opt-in through `include`.
- [List creators](https://docs.passionfroot.me/partner-reference/creators/list-creators.md): Returns creators with a qualifying collaboration with the organization, including private relationship notes and labels.
- [Get a creator](https://docs.passionfroot.me/partner-reference/creators/get-a-creator.md): Returns one creator when the organization has a qualifying collaboration with them.
- [List creator labels](https://docs.passionfroot.me/partner-reference/creators/list-creator-labels.md): Returns the complete workspace label catalog in display order. This endpoint is not paginated.
- [List collaborations](https://docs.passionfroot.me/partner-reference/collaborations/list-collaborations.md): Returns collaborations for the organization, optionally expanded with campaign details.
- [Get a collaboration](https://docs.passionfroot.me/partner-reference/collaborations/get-a-collaboration.md): Returns a collaboration that is accessible to the organization.
- [List conversations](https://docs.passionfroot.me/partner-reference/conversations/list-conversations.md): Returns conversations ordered by most recent message activity. Archived and blocked conversations are included unless filtered out.
- [Mark a conversation as read](https://docs.passionfroot.me/partner-reference/conversations/mark-a-conversation-as-read.md): Clears the organization's unread state without changing `lastActivityAt`. The operation is naturally idempotent.
- [List conversation messages](https://docs.passionfroot.me/partner-reference/conversations/list-conversation-messages.md): Returns the typed conversation timeline newest first. Reading messages does not mark the conversation as read.
- [Send a message](https://docs.passionfroot.me/partner-reference/conversations/send-a-message.md): Sends a text message as the member who created the API key and marks the conversation read for the organization.
- [Send an inquiry](https://docs.passionfroot.me/partner-reference/conversations/send-an-inquiry.md): Sends initial outreach to a creator and creates a conversation and inquiry collaboration when needed.
- [Accept a creator proposal](https://docs.passionfroot.me/partner-reference/proposals/accept-a-creator-proposal.md): Confirms a creator-authored proposal. Accepting an already accepted proposal returns its current state.
- [Reject a creator proposal](https://docs.passionfroot.me/partner-reference/proposals/reject-a-creator-proposal.md): Rejects a creator-authored proposal and cancels the collaboration. Rejection is naturally idempotent.
- [List placements](https://docs.passionfroot.me/creator-reference/placements/list-placements.md): Returns the creator's scheduled deliverables. All prices are creator earnings after Passionfroot fees and before taxes.
- [List partners](https://docs.passionfroot.me/creator-reference/partners/list-partners.md): Returns brands with which the creator has a qualifying collaboration.
- [Get a partner](https://docs.passionfroot.me/creator-reference/partners/get-a-partner.md): Returns one partner when the creator has a qualifying collaboration with it.
- [List collaborations](https://docs.passionfroot.me/creator-reference/collaborations/list-collaborations.md): Returns the creator's collaborations. Prices are creator earnings, not the amount paid by the brand.
- [Get a collaboration](https://docs.passionfroot.me/creator-reference/collaborations/get-a-collaboration.md): Returns one collaboration owned by the creator.
- [List conversations](https://docs.passionfroot.me/creator-reference/conversations/list-conversations.md): Returns conversations ordered by most recent message activity. Deactivated partners are excluded.
- [List conversation messages](https://docs.passionfroot.me/creator-reference/conversations/list-conversation-messages.md): Returns the complete typed timeline newest first. Reading has no side effects. A blocked conversation's timeline is unavailable until it is unblocked in the inbox.
- [Send a message](https://docs.passionfroot.me/creator-reference/conversations/send-a-message.md): Sends a text message to the partner and marks the conversation read for the creator.
- [Mark a conversation as read](https://docs.passionfroot.me/creator-reference/conversations/mark-a-conversation-as-read.md): Marks activity up to the latest observed message as read without changing `lastActivityAt`. Naturally idempotent.
- [List products](https://docs.passionfroot.me/creator-reference/catalog/list-products.md): Returns the creator's complete storefront-visible standalone product catalog. This endpoint is not paginated.
- [List packages](https://docs.passionfroot.me/creator-reference/catalog/list-packages.md): Returns the complete storefront-visible, priced package catalog. This endpoint is not paginated.
- [Accept a package request](https://docs.passionfroot.me/creator-reference/requests/accept-a-package-request.md): Accepts the brand's package request as-is and books the requested dates. An empty body is valid. Naturally idempotent.
- [Decline a package request](https://docs.passionfroot.me/creator-reference/requests/decline-a-package-request.md): Declines the request and sends the reason to the brand. Naturally idempotent.
- [Create a proposal](https://docs.passionfroot.me/creator-reference/proposals/create-a-proposal.md): Replies to a brand request with the creator's own products, dates, and list price. `basePriceCents` is denominated in the collaboration currency and is not the creator payout returned by read endpoints.
- [Counter a proposal](https://docs.passionfroot.me/creator-reference/proposals/counter-a-proposal.md): Cancels the pending proposal and replaces it with a new proposal on the same collaboration.
- [Accept a brand proposal](https://docs.passionfroot.me/creator-reference/proposals/accept-a-brand-proposal.md): Accepts a pending brand-authored proposal and books its dates. Naturally idempotent.
- [Reject a brand proposal](https://docs.passionfroot.me/creator-reference/proposals/reject-a-brand-proposal.md): Rejects the proposal, cancels the collaboration, and releases its dates. Send a separate conversation message if the brand needs a reason. Naturally idempotent.

## OpenAPI Specs

- [creator](/openapi/creator.yaml)
- [partner](/openapi/partner.yaml)