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

# List published changelog entries

> Returns published changelog entries for a project slug.



## OpenAPI

````yaml /openapi.json get /v1/changelog/{slug}
openapi: 3.1.0
info:
  title: SuprLogs API
  version: 0.1.0
  description: >-
    SuprLogs lets you use our changelog database as the source of truth while
    building your own UI. This reference documents the **supported integration
    surface**: a health check, a projects endpoint (authenticated, returns your
    projects with published entries), and public changelog routes for listing
    and fetching individual posts by project slug. Create API keys in the
    dashboard (Settings → API Keys) to call authenticated routes.
  contact:
    name: SuprLogs Support
    url: https://suprlogs.com
    email: support@suprlogs.com
servers:
  - url: https://api.suprlogs.com
    description: Production
  - url: http://localhost:4704
    description: Local
security: []
paths:
  /v1/changelog/{slug}:
    get:
      tags:
        - Changelog
      summary: List published changelog entries
      description: Returns published changelog entries for a project slug.
      operationId: getChangelogBySlug
      parameters:
        - in: path
          name: slug
          required: true
          schema:
            type: string
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 30
        - in: query
          name: offset
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Published entries and metadata.
          content:
            application/json:
              schema:
                type: object
                properties:
                  project:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      slug:
                        type: string
                  entries:
                    type: array
                    items:
                      $ref: '#/components/schemas/ChangelogEntry'
                  meta:
                    type: object
                    properties:
                      limit:
                        type: integer
                      offset:
                        type: integer
                      count:
                        type: integer
        '404':
          description: Project not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    ChangelogEntry:
      type: object
      required:
        - id
        - entry_type
        - status
        - project_id
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        project_id:
          type: string
          format: uuid
        entry_type:
          type: string
          enum:
            - commit
            - daily
            - weekly
            - monthly
        status:
          type: string
          example: published
        title:
          type: string
          nullable: true
        content:
          type: string
          nullable: true
          description: Markdown body.
        generated_json:
          type: object
          nullable: true
          description: >-
            Structured changelog with headline items, sections, and component
            tags.
          properties:
            title:
              type: string
            headline_items:
              type: array
              items:
                type: object
                properties:
                  section_type_key:
                    type: string
                  title:
                    type: string
                  body:
                    type: string
                    nullable: true
            sections:
              type: array
              items:
                type: object
                properties:
                  section_type_key:
                    type: string
                  label:
                    type: string
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        text:
                          type: string
                        component:
                          type: string
                          nullable: true
            component_tags:
              type: array
              items:
                type: string
            team_attribution:
              type: string
              nullable: true
        version_label:
          type: string
          nullable: true
        team_attribution:
          type: string
          nullable: true
        component_tags:
          type: array
          items:
            type: string
        commit_id:
          type: string
          format: uuid
          nullable: true
        commit_shas:
          type: array
          items:
            type: string
        period_start:
          type: string
          format: date-time
          nullable: true
        period_end:
          type: string
          format: date-time
          nullable: true
        published_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Invalid request
        details:
          type: array
          items:
            type: object
      required:
        - error

````