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

# List issues

> Lists recent workspace issues visible to the API key workspace.



## OpenAPI

````yaml /openapi.json get /api/v1/issues
openapi: 3.1.0
info:
  title: Woes REST API
  summary: >-
    Public REST API for Woes workspace conversations, issues, clients, agents,
    sources, definitions, usage, and analytics.
  description: >-
    Use workspace API keys to work with Woes support conversations, messages,
    issues, client account aggregates, public agent metadata, API context
    sources, workspace definitions, usage meters, and sanitized analytics from
    server-side integrations.
  version: '2026-06-29'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://woes.dev
    description: Production
security:
  - workspaceApiKey: []
tags:
  - name: Conversations
    description: Create, read, update, and message support conversations.
  - name: Issues
    description: Create, read, and update support issues.
  - name: Clients
    description: Read client account aggregates derived from workspace conversations.
  - name: Agents
    description: Read named support agent metadata and public widget keys.
  - name: Sources
    description: Create, inspect, update, delete, and rescan API context sources.
  - name: Definitions
    description: Read workspace tags, statuses, priorities, and custom field definitions.
  - name: Usage
    description: Read current-month public API and live API check usage.
  - name: Analytics
    description: Read sanitized workspace analytics aggregates.
paths:
  /api/v1/issues:
    get:
      tags:
        - Issues
      summary: List issues
      description: Lists recent workspace issues visible to the API key workspace.
      operationId: listIssues
      parameters:
        - $ref: '#/components/parameters/IssueStatusCategory'
        - $ref: '#/components/parameters/Priority'
        - $ref: '#/components/parameters/CustomerEmail'
        - $ref: '#/components/parameters/SourceConversationId'
        - $ref: '#/components/parameters/ListLimit'
      responses:
        '200':
          description: Issue list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueListResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    IssueStatusCategory:
      name: statusCategory
      in: query
      schema:
        $ref: '#/components/schemas/IssueStatusCategory'
      description: Issue status category filter.
      example: new
    Priority:
      name: priority
      in: query
      schema:
        type: string
        minLength: 1
        maxLength: 32
      description: Priority label filter.
      example: high
    CustomerEmail:
      name: customerEmail
      in: query
      schema:
        type: string
        format: email
        maxLength: 320
      description: Customer email filter.
      example: ada@example.com
    SourceConversationId:
      name: sourceConversationId
      in: query
      schema:
        type: string
        format: uuid
      description: Linked source conversation id filter.
      example: 6f6b6f9a-1b6a-4e42-9f71-1b9a3f3d2a33
    ListLimit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      description: Number of records to return.
      example: 10
  schemas:
    IssueListResponse:
      type: object
      additionalProperties: false
      required:
        - object
        - hasMore
        - issues
      properties:
        object:
          type: string
          const: list
        hasMore:
          type: boolean
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
    IssueStatusCategory:
      type: string
      enum:
        - new
        - on_you
        - on_customer
        - on_hold
        - closed
    Issue:
      type: object
      additionalProperties: false
      required:
        - object
        - id
        - subject
        - preview
        - description
        - statusCategory
        - priority
        - tags
        - customer
        - source
        - createdAt
        - updatedAt
        - lastActivityAt
        - closedAt
      properties:
        object:
          type: string
          const: issue
        id:
          type: string
        subject:
          type: string
        preview:
          type: string
        description:
          type: string
        statusCategory:
          $ref: '#/components/schemas/IssueStatusCategory'
        priority:
          type: string
        tags:
          type: array
          items:
            type: string
        customer:
          $ref: '#/components/schemas/IssueCustomer'
        source:
          $ref: '#/components/schemas/IssueSource'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        lastActivityAt:
          type: string
          format: date-time
        closedAt:
          type:
            - string
            - 'null'
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - code
        - error
      properties:
        code:
          type: string
        error:
          type: string
    IssueCustomer:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          maxLength: 160
        email:
          type:
            - string
            - 'null'
          format: email
          maxLength: 320
        company:
          type: string
          maxLength: 160
    IssueSource:
      type: object
      additionalProperties: false
      required:
        - channel
        - conversationId
      properties:
        channel:
          type:
            - string
            - 'null'
        conversationId:
          type:
            - string
            - 'null'
  responses:
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidRequest:
              value:
                code: invalid_request
                error: Request body is invalid.
    Unauthorized:
      description: Missing, unknown, revoked, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                code: unauthorized
                error: A valid workspace API key is required.
    InsufficientScope:
      description: API key does not include the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientScope:
              value:
                code: insufficient_scope
                error: This API key is missing the required scope.
    RateLimited:
      description: Too many API requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                code: rate_limited
                error: Too many API requests. Slow down and try again shortly.
    InternalError:
      description: Unexpected API failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              value:
                code: internal_error
                error: The API request could not be completed.
  securitySchemes:
    workspaceApiKey:
      type: http
      scheme: bearer
      description: >-
        Workspace API key that starts with woesk_. Paste your own key into the
        docs playground; never expose it in browser code.
      x-default: woesk_your_api_key_here

````