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

# List maintenance messages

> Lists the conversation on one maintenance issue, oldest first. An `issue` is required, and is what a tenant’s access is proven against.



## OpenAPI

````yaml openapi-maintenance.json GET /v1/maintenance/messages
openapi: 3.1.0
info:
  title: Yorlet Maintenance API
  description: >-
    APIs for managing maintenance issues, the jobs raised against them, supplier
    quotes, and the conversation with the tenant.
  version: 1.0.0
servers:
  - url: https://api.yorlet.com
    description: Production
  - url: https://api.yorlet.io
    description: Sandbox
security: []
paths:
  /v1/maintenance/messages:
    get:
      tags:
        - Maintenance Messages
      summary: List maintenance messages
      description: >-
        Lists the conversation on one maintenance issue, oldest first. An
        `issue` is required, and is what a tenant’s access is proven against.
      operationId: maintenance_messages_list
      responses:
        '200':
          description: >-
            A object with a data property that contains an array of maintenance
            messages.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                    description: Total number of items in the list.
                    example: 1
                  has_more:
                    type: boolean
                    description: Whether more items are available.
                    example: false
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the object.
                        created:
                          type: number
                          description: >-
                            Time at which the object was created. Measured in
                            seconds since the Unix epoch.
                        account:
                          type: string
                          description: >-
                            The account that the object belongs to. Only
                            returned if the request is made with a valid
                            Yorlet-Context header.
                        deleted:
                          type: boolean
                          default: false
                          description: Only returned if the object has been deleted.
                        object:
                          type: string
                          enum:
                            - maintenance.message
                        created_by:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: string
                              description: Unique identifier for the object.
                            created:
                              type: number
                              description: >-
                                Time at which the object was created. Measured
                                in seconds since the Unix epoch.
                            account:
                              type: string
                              description: >-
                                The account that the object belongs to. Only
                                returned if the request is made with a valid
                                Yorlet-Context header.
                            deleted:
                              type: boolean
                              default: false
                              description: Only returned if the object has been deleted.
                            object:
                              type: string
                              enum:
                                - user
                            email:
                              type: string
                            name:
                              type:
                                - string
                                - 'null'
                          description: >-
                            The member of the team who sent the message. `null`
                            on a message from the tenant.
                          required:
                            - id
                            - created
                            - object
                            - email
                            - name
                        customer:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                            - type: 'null'
                          description: >-
                            The tenant who sent the message. `null` on a message
                            from the team.
                        issue:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                          description: The maintenance issue the message belongs to.
                        sender:
                          type: string
                          enum:
                            - team
                            - tenant
                          description: >-
                            Which side of the conversation the message came
                            from.
                        text:
                          type: string
                          description: The text content of the message.
                      required:
                        - id
                        - created
                        - object
                        - created_by
                        - customer
                        - issue
                        - sender
                        - text
                required:
                  - count
                  - has_more
                  - object
                  - data
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API Key authentication. Use "Bearer YOUR_API_KEY".

````