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

# Invite a manager or collaborator

> Invites a new user to the current account. Requires an API key belonging
to an account owner or manager.

**Managers** receive a Devise admin invitation. They may only be invited
if they are on the free plan with no feeds and no existing enterprise
account. `feed_ids` is ignored for managers — managers gain access to all
feeds on the account once they accept the invitation.

**Collaborators** can be invited with or without feeds. When `feed_ids`
is provided, each ID must belong to the current account and the collaborator
is assigned to those feeds (first feed triggers a "new feed" email for
existing users; new users receive a Devise invitation). When `feed_ids`
is omitted or empty, the collaborator is pre-provisioned with no
assignments — feeds can be attached later via
`PUT /v1/users/{user_id}/feeds/{feed_id}`.

Inviting users (either role) requires the **Enterprise** or **Team**
plan. Accounts on other plans receive `422` with
`error.code = "user_limit_reached"` and an `error.action` of type
`upgrade_plan` containing a magic link to the upgrade page.




## OpenAPI

````yaml /openapi/v1.yaml post /users
openapi: 3.1.0
info:
  title: Juicer API v1
  version: 1.0.0
  description: >
    The Juicer API provides two products under one API key:


    1. **Integration API** — Programmatically manage feeds, sources, posts, and
    moderation

    2. **Data API** — Query social posts for a handle or hashtag without
    creating a feed


    ## Authentication

    All requests require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer jcr_your_api_key_here

    ```

    API keys can be created from the Developer page in the Juicer dashboard,

    **or** programmatically via `POST /v1/authorize` — see step 0 of the

    Quick Start below. No prior signup or dashboard access is required.


    ## Quick Start


    Create a feed, add a source, and get the embed code:


    ```bash

    # 0. Get an API key (no dashboard needed)

    curl -X POST https://api.juicer.io/v1/authorize \
      -H "Content-Type: application/json" \
      -d '{"email": "you@example.com", "client_name": "My Tool"}'
    # New email → returns `api_key` immediately (temporary until email
    confirmed).

    # Existing user → returns an `authorization_url` (user approves) and a

    # `poll_url`; GET the poll_url until it returns the `api_key`.


    # 1. Check your account

    curl https://api.juicer.io/v1/account \
      -H "Authorization: Bearer jcr_your_key"

    # 2. See available platforms

    curl https://api.juicer.io/v1/platforms \
      -H "Authorization: Bearer jcr_your_key"

    # 3. Create a feed

    curl -X POST https://api.juicer.io/v1/feeds \
      -H "Authorization: Bearer jcr_your_key" \
      -H "Content-Type: application/json" \
      -d '{"name": "My Brand Feed"}'

    # 4. Add a YouTube source

    curl -X POST https://api.juicer.io/v1/feeds/{feed_id}/sources \
      -H "Authorization: Bearer jcr_your_key" \
      -H "Content-Type: application/json" \
      -d '{"platform": "YouTube", "term": "NASA", "term_type": "username"}'

    # 5. Get embed code for your website

    curl https://api.juicer.io/v1/feeds/{feed_id}/embed \
      -H "Authorization: Bearer jcr_your_key"
    ```


    The embed endpoint returns ready-to-use snippets:


    - **JavaScript** — `<script>` tag for any website

    - **iframe** — For platforms that don't allow JavaScript

    - **WordPress shortcode** — `[juicer name='your-feed']`

    - **WordPress PHP** — `<?php juicer_feed('name=your-feed'); ?>`


    ## Discovering Platforms


    Use `GET /platforms` to see all available social media platforms and their

    supported term types (username, hashtag, mentions, etc.) before creating
    sources.

    Each term type includes its OAuth connection requirements, so you know
    upfront

    whether the user needs to connect an account first.


    ## Connecting Social Accounts


    Several platforms require a connected social account before you can create

    sources. The exact list and the per-term-type requirement depend on the

    caller's account configuration — always discover requirements at runtime

    from `GET /platforms` (the `requires_connection` field on each term type)

    or `GET /social_accounts/status`. The flow when a connection is needed:


    1. `GET /social_accounts/status` — check which platforms need connecting

    2. `POST /social_accounts/connect_url` with `{"provider": "facebook"}` —
    generates a magic link

    3. User clicks the link — it signs them in and starts the authorization flow
    (no Juicer login needed)

    4. `GET /social_accounts` — verify the account is now connected

    5. Create sources for that platform as normal


    The magic link expires in 30 minutes and can only be used once. This makes

    it suitable for AI agents and CLI tools that need to walk a user through

    social account setup.


    **Note:** If you try to create a source that requires a connected account

    and none is available, the API returns a `422` error with

    `error.code = "social_account_required"` and an `error.action` containing

    a magic link the user can click to complete the connection.


    ## Plan Limits


    Your plan determines how many feeds and sources you can create. If you hit

    a limit, the API returns a `422` error with `error.code =
    "feed_limit_reached"`

    or `"source_limit_reached"`, along with an `error.action` of type
    `"upgrade_plan"`

    that includes a magic link to the upgrade page with the correct plan
    pre-selected.
servers:
  - url: https://api.juicer.io/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Quickstart
    description: Get an API key with just an email, no dashboard required
  - name: Account
    description: Account info, usage, and limits
  - name: Platforms
    description: Discover available platforms and term types
  - name: Social Accounts
    description: Manage OAuth social account connections needed for certain platforms
  - name: Feeds
    description: Manage feeds (create, update, delete, list)
  - name: Sources
    description: Manage sources within feeds
  - name: Posts
    description: Read, search, and moderate posts
  - name: Embed
    description: Get embed code snippets for your website
  - name: Search
    description: Search posts across all feeds
  - name: Analytics
    description: Feed engagement analytics and performance
  - name: Webhooks
    description: Webhook subscriptions and event delivery
  - name: Data API
    description: One-off post lookups for a handle or hashtag without creating a feed
paths:
  /users:
    post:
      tags:
        - Users
      summary: Invite a manager or collaborator
      description: >
        Invites a new user to the current account. Requires an API key belonging

        to an account owner or manager.


        **Managers** receive a Devise admin invitation. They may only be invited

        if they are on the free plan with no feeds and no existing enterprise

        account. `feed_ids` is ignored for managers — managers gain access to
        all

        feeds on the account once they accept the invitation.


        **Collaborators** can be invited with or without feeds. When `feed_ids`

        is provided, each ID must belong to the current account and the
        collaborator

        is assigned to those feeds (first feed triggers a "new feed" email for

        existing users; new users receive a Devise invitation). When `feed_ids`

        is omitted or empty, the collaborator is pre-provisioned with no

        assignments — feeds can be attached later via

        `PUT /v1/users/{user_id}/feeds/{feed_id}`.


        Inviting users (either role) requires the **Enterprise** or **Team**

        plan. Accounts on other plans receive `422` with

        `error.code = "user_limit_reached"` and an `error.action` of type

        `upgrade_plan` containing a magic link to the upgrade page.
      operationId: createUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
      responses:
        '201':
          description: User invited
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/User'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Caller is not an account owner or manager
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  schemas:
    UserCreateRequest:
      type: object
      required:
        - email
        - role
      properties:
        email:
          type: string
          format: email
        role:
          type: string
          enum:
            - manager
            - collaborator
        feed_ids:
          type: array
          description: |
            Optional. When `role` is `collaborator` and feeds are provided, the
            collaborator is assigned to each feed on creation (all must belong
            to the current account). When omitted or empty, the collaborator
            is created without any assignments and feeds can be attached later.
            Ignored when `role` is `manager`.
          items:
            type: integer
        skip_invitation_email:
          type: boolean
          default: false
          description: |
            When `true`, Juicer does not email the invited user. This suppresses
            both the Devise invitation email and, for collaborators with
            `feed_ids`, the "new feed" notification. Use this when your
            application handles user onboarding/notifications itself and the
            end-user should not be aware of Juicer as a separate product.
    User:
      type: object
      required:
        - id
        - email
        - role
        - invitation_accepted
        - invitation_pending
        - feed_ids
        - created_at
      properties:
        id:
          type: integer
        email:
          type: string
          format: email
        role:
          type: string
          enum:
            - owner
            - manager
            - collaborator
        invitation_accepted:
          type: boolean
          description: >-
            Whether the user has accepted a Devise invitation (true for any user
            who signed up normally).
        invitation_pending:
          type: boolean
          description: True when the user has an outstanding unaccepted invitation.
        feed_ids:
          type: array
          description: >
            IDs of feeds the user currently has an assignment for. For managers
            this

            will reflect the assignments created when they accepted their
            invitation;

            for collaborators it reflects the feeds they were assigned to.
          items:
            type: integer
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >
                Machine-readable error code. Possible values:

                - `unauthorized` — Missing or invalid API key

                - `forbidden` — API not enabled for account

                - `not_found` — Resource not found

                - `parameter_missing` — Required parameter not provided

                - `validation_failed` — Model validation failed (see `details`)

                - `feed_limit_reached` — Plan's feed limit exceeded (see
                `action`)

                - `source_limit_reached` — Feed's source limit exceeded (see
                `action`)

                - `user_limit_reached` — Plan doesn't include team members (see
                `action`)

                - `social_account_required` — OAuth connection needed (see
                `action`)

                - `invalid_platform` — Platform not supported

                - `invalid_provider` — Unknown OAuth provider

                - `invalid_status` — Invalid post status filter

                - `invalid_action_type` — Invalid bulk moderation action

                - `query_required` — Search query not provided
              example: feed_limit_reached
            message:
              type: string
              description: Human-readable error message
              example: Your Free plan allows 1 feed(s). Upgrade to create more.
            details:
              type: object
              nullable: true
              description: >-
                Field-level validation errors. Present when `code` is
                `validation_failed`.
              additionalProperties:
                type: array
                items:
                  type: string
              example:
                name:
                  - can't be blank
            action:
              nullable: true
              description: >
                Actionable fix for the error. Present when the error can be
                resolved

                by the user taking a specific action (upgrading plan or
                connecting a social account).

                The `type` field tells you what kind of action is needed.
              oneOf:
                - $ref: '#/components/schemas/UpgradePlanAction'
                - $ref: '#/components/schemas/ConnectSocialAccountAction'
    UpgradePlanAction:
      type: object
      description: >
        Returned when a plan limit is hit (feed limit, source limit).

        The `upgrade_url` is a magic link — the user clicks it, gets signed in

        automatically, and lands on the upgrade page with the right plan
        pre-selected.
      properties:
        type:
          type: string
          enum:
            - upgrade_plan
        current_plan:
          type: string
          example: small
        current_plan_display_name:
          type: string
          example: Free
        required_plan:
          type: string
          description: The minimum plan that unlocks this feature
          example: large
        required_plan_display_name:
          type: string
          example: Pro
        upgrade_url:
          type: string
          description: >-
            Magic link — signs user in and redirects to the upgrade page.
            Expires in 30 minutes.
        expires_at:
          type: string
          format: date-time
    ConnectSocialAccountAction:
      type: object
      description: >
        Returned when a source requires an OAuth-connected social account.

        The `connection_url` is a magic link — the user clicks it, gets signed
        in

        automatically, and starts the OAuth authorization flow.
      properties:
        type:
          type: string
          enum:
            - connect_social_account
        provider:
          type: string
          description: OAuth provider to connect
          example: facebook
        connection_url:
          type: string
          description: >-
            Magic link — signs user in and starts OAuth flow. Expires in 30
            minutes.
        expires_at:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnprocessableEntity:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        API key prefixed with `jcr_`. To obtain a key programmatically
        (no dashboard required), see `POST /v1/authorize`.

````