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

# List blog posts

> Returns posts page by page, drafts included unless filtered out. Posts come newest-created first; with `status=published`, most recently published first. Page through with `page` and `limit` until you have `total_count` posts. Requires the blog read permission.



## OpenAPI

````yaml /openapi.json get /api/blogPosts.list
openapi: 3.0.3
info:
  title: Notifuse API
  description: API for Notifuse - a transactional email and newsletter management platform
  version: 1.0.0
  contact:
    name: Notifuse Support
    url: https://www.notifuse.com/support
    email: hello@notifuse.com
  license:
    name: BUSL-1.1
    url: https://github.com/Notifuse/notifuse/blob/main/LICENSE
servers:
  - url: https://{notifuseDomain}
    description: Customer-specific Notifuse API server
    variables:
      notifuseDomain:
        description: Your unique Notifuse domain
        default: demo.notifuse.com
security: []
paths:
  /api/blogPosts.list:
    get:
      tags:
        - Blog
      summary: List blog posts
      description: >-
        Returns posts page by page, drafts included unless filtered out. Posts
        come newest-created first; with `status=published`, most recently
        published first. Page through with `page` and `limit` until you have
        `total_count` posts. Requires the blog read permission.
      operationId: listBlogPosts
      parameters:
        - name: workspace_id
          in: query
          required: true
          schema:
            type: string
          description: The ID of the workspace
          example: ws_1234567890
        - name: category_id
          in: query
          required: false
          schema:
            type: string
          description: Only posts in this category.
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - draft
              - published
            default: all
          description: >-
            `draft` is posts never published or since unpublished; `published`
            is every post with a publication date, including one dated in the
            future.
          example: published
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: 1-indexed page number.
          example: 2
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
            maximum: 100
          description: >-
            Posts per page. Values above the maximum are clamped to it rather
            than refused.
          example: 50
      responses:
        '200':
          description: One page of posts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBlogPostsResponse'
        '400':
          description: Bad request - invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingWorkspaceId:
                  value:
                    error: workspace_id is required
                invalidPage:
                  value:
                    error: page must be a valid integer
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - missing the blog read permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionErrorResponse'
              example:
                error: 'Insufficient permissions: read access to blog required'
                resource: blog
                permission: read
        '500':
          description: >-
            Internal server error. Also returned for a `status` outside the
            enum.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Failed to list posts
      security:
        - BearerAuth: []
components:
  schemas:
    ListBlogPostsResponse:
      type: object
      required:
        - posts
        - total_count
      properties:
        posts:
          type: array
          nullable: true
          description: The requested page. `null` rather than `[]` when the page is empty.
          items:
            $ref: '#/components/schemas/BlogPost'
        total_count:
          type: integer
          description: Posts matching the filters across all pages.
          example: 128
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
        - error
    PermissionErrorResponse:
      type: object
      description: >-
        Returned with a 403 when the user or API key lacks the permission the
        endpoint requires.
      properties:
        error:
          type: string
          description: Error message
        resource:
          type: string
          description: The permission resource the endpoint requires.
          example: blog
        permission:
          type: string
          enum:
            - read
            - write
          description: The access level the endpoint requires on that resource.
      required:
        - error
        - resource
        - permission
    BlogPost:
      type: object
      required:
        - id
        - category_id
        - slug
        - settings
        - created_at
        - updated_at
      properties:
        id:
          type: string
          description: Server-generated UUID.
          example: 1b4e28ba-2fa1-11d2-883f-0016d3cca427
        category_id:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        slug:
          type: string
          description: >-
            The post's path segment on the blog
            (`/{category_slug}/{post_slug}`).
          example: october-release
        settings:
          type: object
          required:
            - title
            - template
            - reading_time_minutes
          properties:
            title:
              type: string
              description: The post's H1.
              example: What shipped in October
            template:
              type: object
              required:
                - template_id
                - template_version
              description: The web template holding the post body.
              properties:
                template_id:
                  type: string
                  example: blog_october_release
                template_version:
                  type: integer
                  description: >-
                    The template version the post renders. `0` means the latest
                    version, whatever it is at render time.
                  example: 3
            excerpt:
              type: string
              example: A faster editor, scheduled broadcasts and a new API.
            featured_image_url:
              type: string
              example: https://cdn.example.com/blog/october.png
            authors:
              type: array
              nullable: true
              items:
                $ref: '#/components/schemas/BlogAuthor'
            reading_time_minutes:
              type: integer
              description: Displayed as given; not computed from the body.
              example: 4
            seo:
              $ref: '#/components/schemas/SEOSettings'
        published_at:
          type: string
          format: date-time
          description: Absent while the post is a draft.
          example: '2026-10-01T09:00:00Z'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    BlogAuthor:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          example: Jane Doe
        avatar_url:
          type: string
          example: https://cdn.example.com/avatars/jane.png
    SEOSettings:
      type: object
      description: Search and social metadata for the page, exposed to the blog theme.
      properties:
        meta_title:
          type: string
          example: Release notes for October
        meta_description:
          type: string
          example: Everything that shipped this month.
        og_title:
          type: string
          description: Open Graph title
        og_description:
          type: string
          description: Open Graph description
        og_image:
          type: string
          description: Open Graph image URL
          example: https://cdn.example.com/og/october.png
        canonical_url:
          type: string
          example: https://blog.example.com/product/october-release
        keywords:
          type: array
          items:
            type: string
          example:
            - release
            - changelog
        meta_robots:
          type: string
          description: Content of the robots meta tag.
          example: index,follow
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication

````