> ## 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 all maintenance jobs



## OpenAPI

````yaml openapi-maintenance.json GET /v1/maintenance/jobs
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/jobs:
    get:
      tags:
        - Maintenance Jobs
      summary: List all maintenance jobs
      operationId: maintenance_jobs_list
      responses:
        '200':
          description: >-
            A object with a data property that contains an array of maintenance
            jobs.
          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.job
                        approved_quote:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                            - type: 'null'
                          description: >-
                            The quote that was approved for the job, if the job
                            was costed by quoting.
                        assignee:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                            - type: 'null'
                          description: The user responsible for the job.
                        canceled_at:
                          type:
                            - integer
                            - 'null'
                          description: The time at which the job was canceled.
                        cancellation_reason:
                          type:
                            - string
                            - 'null'
                          description: Why the job was canceled.
                        completed_at:
                          type:
                            - integer
                            - 'null'
                          description: The time at which the job was completed.
                        completion_notes:
                          type:
                            - string
                            - 'null'
                          description: What was done, recorded when the job was completed.
                        cost:
                          type:
                            - object
                            - 'null'
                          properties:
                            amount:
                              type: integer
                              description: >-
                                The cost of the job, in the smallest currency
                                unit.
                            currency:
                              type: string
                              enum:
                                - gbp
                                - usd
                                - eur
                                - sek
                              description: >-
                                Three-letter ISO currency code, in lowercase.
                                Must be a supported currency.
                              example: gbp
                          description: >-
                            What the job will cost, from the approved quote or
                            entered directly for work done in house. `null`
                            until the job has been costed.
                          required:
                            - amount
                            - currency
                        description:
                          type:
                            - string
                            - 'null'
                          description: A description of the work to be done.
                        in_house:
                          type: boolean
                          description: >-
                            Whether the work is being done in house rather than
                            by an external supplier.
                        invoices:
                          type: array
                          items:
                            type: string
                          description: IDs of files uploaded as invoices for the job.
                        issue:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                          description: The maintenance issue the job belongs to.
                        landlord_approval:
                          type: object
                          properties:
                            method:
                              type:
                                - string
                                - 'null'
                              enum:
                                - link
                                - agent
                                - null
                              description: >-
                                How the decision was recorded: `link` when the
                                landlord used the link in their email, `agent`
                                when a member of the team recorded it on their
                                behalf.
                            note:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Anything the landlord said alongside their
                                decision, or the reason an agent recorded on
                                their behalf.
                            owner:
                              anyOf:
                                - type: string
                                - type: object
                                  additionalProperties: {}
                                - type: 'null'
                              description: The owner whose approval was sought.
                            recorded_at:
                              type:
                                - integer
                                - 'null'
                              description: The time at which the decision was recorded.
                            recorded_by:
                              anyOf:
                                - type: string
                                - type: object
                                  additionalProperties: {}
                                - type: 'null'
                              description: >-
                                The user who recorded the decision, when an
                                agent recorded it on the landlord’s behalf.
                            requested_at:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                The time at which approval was requested from
                                the landlord.
                            status:
                              type: string
                              enum:
                                - not_required
                                - pending
                                - approved
                                - rejected
                              description: Where the job stands with the landlord.
                            threshold_amount:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                The unit’s spend threshold at the time approval
                                was requested, in the smallest currency unit.
                                Kept so the decision can still be read against
                                the rule that triggered it.
                          description: >-
                            Where the job stands with the landlord whose
                            property it is.
                          required:
                            - method
                            - note
                            - owner
                            - recorded_at
                            - recorded_by
                            - requested_at
                            - status
                            - threshold_amount
                        name:
                          type: string
                          description: The name of the job.
                        scheduled_end_at:
                          type:
                            - integer
                            - 'null'
                          description: When the visit is expected to finish.
                        scheduled_start_at:
                          type:
                            - integer
                            - 'null'
                          description: When the visit is expected to start.
                        started_at:
                          type:
                            - integer
                            - 'null'
                          description: The time at which work started.
                        status:
                          type: string
                          enum:
                            - draft
                            - quoting
                            - approved
                            - scheduled
                            - in_progress
                            - completed
                            - canceled
                          description: The status of the job.
                        supplier:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                            - type: 'null'
                          description: The supplier carrying out the work.
                        unit:
                          anyOf:
                            - type: string
                            - type: object
                              additionalProperties: {}
                            - type: 'null'
                          description: The unit the work is at, taken from the issue.
                      required:
                        - id
                        - created
                        - object
                        - approved_quote
                        - assignee
                        - canceled_at
                        - cancellation_reason
                        - completed_at
                        - completion_notes
                        - cost
                        - description
                        - in_house
                        - invoices
                        - issue
                        - landlord_approval
                        - name
                        - scheduled_end_at
                        - scheduled_start_at
                        - started_at
                        - status
                        - supplier
                        - unit
                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".

````