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

# List services



## OpenAPI

````yaml /docs/service-api.yaml get /services
openapi: 3.1.0
info:
  title: Spartan Service API
  version: 1.1.0
  description: >-
    Service inventory, lifecycle, billing, pricing, notes, members, addons,
    provider service details, upgrades, downgrades, and evidence. All operations
    require a bearer API token with the documented `x-permission`.
servers:
  - url: https:/docs.dezerx.com/api/application
    description: Development
security:
  - bearerAuth: []
tags:
  - name: Services
  - name: Lifecycle
  - name: Billing
  - name: Members
  - name: Service Details
  - name: Evidence
paths:
  /services:
    get:
      tags:
        - Services
      summary: List services
      parameters:
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/PerPage'
        - name: status
          in: query
          schema:
            type: string
        - name: owner
          in: query
          schema:
            type: integer
        - name: product
          in: query
          schema:
            type: integer
        - name: category
          in: query
          schema:
            type: integer
        - name: module
          in: query
          schema:
            type: string
        - name: billing_cycle
          in: query
          schema:
            type: string
        - name: sort
          in: query
          schema:
            enum:
              - id
              - name
              - status
              - price
              - due_date
              - created_at
              - updated_at
        - name: direction
          in: query
          schema:
            enum:
              - asc
              - desc
      responses:
        '200':
          $ref: '#/components/responses/ServiceCollection'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
components:
  parameters:
    Search:
      name: search
      in: query
      schema:
        type: string
        maxLength: 255
    PerPage:
      name: per_page
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  responses:
    ServiceCollection:
      description: Paginated services
      content:
        application/json:
          schema:
            type: object
            required:
              - data
              - meta
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Service'
              meta:
                type: object
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Service:
      type: object
      required:
        - id
        - status
        - price
      properties:
        id:
          type: integer
        name:
          type:
            - string
            - 'null'
        status:
          type: string
        owner:
          type:
            - object
            - 'null'
        product:
          type:
            - object
            - 'null'
        category:
          type:
            - object
            - 'null'
        module:
          type:
            - string
            - 'null'
        price:
          type: number
        billing_cycle:
          type:
            - string
            - 'null'
        due_date:
          type:
            - string
            - 'null'
          format: date-time
        addons:
          type: array
    Error:
      type: object
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
        request_id:
          type: string
          format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````