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

# List Posts

> **Availability: pending.** This endpoint is specified ahead of implementation and is not yet live on the hosted API; it ships through recoupable/app#2241. Do not rely on it until this notice is removed.

The account's posts, newest first, with each one's status and live URL.



## OpenAPI

````yaml api-reference/openapi/social.json GET /api/posts
openapi: 3.1.0
info:
  title: Recoup API - Social
  description: >-
    API documentation for the Recoup platform - an AI agent platform for the
    music industry
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.recoupable.dev
security: []
paths:
  /api/posts:
    get:
      summary: List posts
      description: >-
        **Availability: pending.** This endpoint is specified ahead of
        implementation and is not yet live on the hosted API; it ships through
        recoupable/app#2241. Do not rely on it until this notice is removed.


        The account's posts, newest first, with each one's status and live URL.
      parameters:
        - name: account_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Optional. Act on behalf of another account you can access. Defaults
            to the calling account.
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - scheduled
              - publishing
              - posted
              - failed
              - cancelled
          description: Optional. Return only posts in this state.
        - name: platform
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/PostPlatform'
          description: Optional. Return only posts to this platform.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 50
          description: Optional. Maximum posts to return, newest first.
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Optional. Number of posts to skip, for paging.
      responses:
        '200':
          description: Posts in the requested account, newest first.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostListResponse'
        '400':
          description: Invalid query parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostErrorResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostErrorResponse'
        '403':
          description: Access denied to the specified `account_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostErrorResponse'
      security:
        - apiKeyAuth: []
        - bearerAuth: []
components:
  schemas:
    PostPlatform:
      type: string
      enum:
        - instagram
        - x
        - linkedin
        - youtube
      description: Target platform. The account must have this platform connected.
    PostListResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          description: Status of the request
        posts:
          type: array
          description: Posts, newest first. Empty when the account has none.
          items:
            $ref: '#/components/schemas/Post'
    PostErrorResponse:
      type: object
      required:
        - status
        - error
      properties:
        status:
          type: string
          enum:
            - error
          description: Always `error`
        missing_fields:
          type: array
          description: >-
            JSON path segments to the first field that failed validation, e.g.
            `["description"]`
          items:
            oneOf:
              - type: string
              - type: integer
        error:
          type: string
          description: Human-readable error message
    Post:
      type: object
      description: One post to one account.
      properties:
        id:
          type: string
          format: uuid
          description: The post's id.
        account_id:
          type: string
          format: uuid
          description: The account whose connection posts.
        platform:
          $ref: '#/components/schemas/PostPlatform'
        sub_account_id:
          type:
            - string
            - 'null'
          description: LinkedIn organization URN when posting as a Page, else null.
        status:
          $ref: '#/components/schemas/PostStatus'
        video_url:
          type: string
          description: The video that is or was published.
        cover_url:
          type:
            - string
            - 'null'
          description: The cover or thumbnail image, if any.
        title:
          type:
            - string
            - 'null'
          description: Submitted title.
        description:
          type:
            - string
            - 'null'
          description: Submitted body text.
        privacy:
          type:
            - string
            - 'null'
          description: Submitted YouTube visibility.
        tags:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Submitted YouTube tags.
        publish_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Requested publish time. Null when published on creation.
        post_url:
          type:
            - string
            - 'null'
          description: Live URL on the platform. Null until `posted`.
        error_message:
          type:
            - string
            - 'null'
          description: >-
            Why publishing failed, as returned by the platform (e.g. a daily
            upload quota). Null unless `status` is `failed`.
        text_verified:
          type:
            - boolean
            - 'null'
          description: >-
            Whether the live text, re-read from the platform after posting,
            equals the submitted `title`/`description`. Null until checked.
        created_at:
          type: string
          format: date-time
          description: When the post was created.
        updated_at:
          type: string
          format: date-time
          description: When the post last changed.
    PostStatus:
      type: string
      enum:
        - scheduled
        - publishing
        - posted
        - failed
        - cancelled
      description: >-
        Lifecycle phase. `scheduled` until `publish_at`, `publishing` while the
        platform upload runs, then `posted` or `failed`. `cancelled` only from
        `scheduled`.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Recoup API key. [Learn more](/quickstart#api-keys).
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.