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

# List posts

> Your posts a page at a time: newest first, or soonest first for scheduled ones. Pass next_cursor as cursor for the next page.

Needs an API key with the `read` scope.



## OpenAPI

````yaml /openapi.json get /posts
openapi: 3.1.0
info:
  title: PostMesh API
  version: 1.0.0
  description: >-
    The PostMesh API posts, schedules and reads your posts on every network you
    connected, with JSON in and out.


    **Authentication.** Send an API key from Settings, API & MCP as
    `Authorization: Bearer pm_live_...`. Each key has scopes (read, drafts,
    publish, media); every endpoint says which it needs.


    **Retries.** Send an `Idempotency-Key` header (up to 255 printable
    characters, a UUID is ideal) with every POST. Sending the same key again
    within 24 hours answers with the first request's status and body instead of
    posting twice, and says so with `Idempotent-Replayed: true`. A request still
    running under the key answers 409; one that failed with a 5xx or 429 frees
    the key, so the retry runs. The same key with a different body is refused
    with 422.


    **Rate limits.** Each key may make 120 requests a minute. Every answer
    carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`
    (Unix seconds); a 429 also carries `Retry-After`. Posting and uploads have
    their own, smaller limits.


    **Errors.** A refusal is JSON with `error` (plain words) and `code` (stable,
    to act on).
servers:
  - url: https://postmesh.app/api/v1
security:
  - apiKey: []
tags:
  - name: Posts
    description: Send, schedule, change and read posts.
  - name: Drafts
    description: Posts saved for later.
  - name: Media
    description: Images and videos for posts.
  - name: Accounts
    description: Your connected accounts and your plan.
  - name: Analytics
    description: How your posts did.
paths:
  /posts:
    get:
      tags:
        - Posts
      summary: List posts
      description: >-
        Your posts a page at a time: newest first, or soonest first for
        scheduled ones. Pass next_cursor as cursor for the next page.


        Needs an API key with the `read` scope.
      operationId: listPosts
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - scheduled
              - sent
              - failed
              - cancelled
          description: all when left out.
        - name: platform
          in: query
          required: false
          schema:
            type: string
            enum:
              - twitter
              - youtube
              - instagram
              - tiktok
              - threads
              - facebook
              - linkedin
              - reddit
              - bluesky
              - mastodon
              - telegram
              - discord
          description: A network PostMesh posts to.
        - name: label
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Only posts with this label.
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
          description: Words in the caption.
        - name: from
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: Start of a window, a date or date-time, inclusive.
        - name: to
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: End of the window, exclusive. At most 366 days after from.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
          description: 1 to 50, 20 when left out.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 512
          description: next_cursor from the page before.
        - name: count
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: true counts every post the filters match (first page only).
      responses:
        '200':
          description: A page of posts.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/Unavailable'
components:
  headers:
    X-RateLimit-Limit:
      description: Requests this key may make in a minute.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left this minute.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the minute resets, in Unix seconds.
      schema:
        type: integer
  schemas:
    PostList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Post'
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
        total:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - data
        - next_cursor
      additionalProperties: false
    Post:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - scheduled
            - awaiting_approval
            - needs_review
            - processing
            - sent
            - failed
            - cancelled
        platforms:
          type: array
          items:
            type: string
        text:
          type: string
        text_cut:
          description: The text was cut to fit; GET /posts/{id} has all of it.
          type: boolean
          const: true
        scheduled_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          description: Send it back as expected_updated_at to change only this version.
          type: string
          format: date-time
        source:
          description: Where the post came from.
          type: string
          enum:
            - app
            - agent
            - mcp
            - api
            - csv
            - clip_factory
        error:
          type: string
        accounts:
          description: Each account's outcome, once the post went out or failed.
          type: array
          items:
            type: object
            properties:
              account_id:
                type: string
              platform:
                type: string
              username:
                type: string
              result:
                type: string
                enum:
                  - posted
                  - processing
                  - failed
                  - unconfirmed
              url:
                description: The live post on the network.
                type: string
              error:
                type: string
            required:
              - platform
              - result
            additionalProperties: false
        label_ids:
          type: array
          items:
            type: string
            format: uuid
      required:
        - id
        - status
        - platforms
        - text
        - created_at
      additionalProperties: false
      description: 'A post: sent, scheduled, waiting or failed.'
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong, in plain words.
        code:
          type: string
          description: >-
            A stable code to act on, such as invalid_request, rate_limited or
            idempotency_key_reused.
        field:
          description: The request field that was refused.
          type: string
        retry_after:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - error
        - code
      additionalProperties: false
      description: Every refusal looks like this.
  responses:
    BadRequest:
      description: >-
        The request was refused: a field is missing or invalid. `field` names
        it.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: No API key, or one that isn't valid any more.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The key can't do this: it needs another scope (`code` is
        `api_key_scope`), or it is in approval mode.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too many requests. Wait for `Retry-After` seconds.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          description: Seconds to wait.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unavailable:
      description: PostMesh can't answer right now. Try again shortly.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key from Settings, API & MCP: pm_live_...'

````

## Related topics

- [MCP tool reference](https://postmesh.app/docs/mcp-tools.md)
- [List connected accounts](https://postmesh.app/docs/api-reference/accounts/list-connected-accounts.md)
- [Analytics for posts sent from PostMesh](https://postmesh.app/docs/analytics.md)
- [List media](https://postmesh.app/docs/api-reference/media/list-media.md)
- [AI Agent: draft posts for every network](https://postmesh.app/docs/ai-agent.md)


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