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

# List services

> The billing account's services, newest first: the live ones by
default, or the ended ones with `status=ended`. Addons are listed on
their service. Needs `services.view`.



## OpenAPI

````yaml /api-reference/console/openapi.json get /services
openapi: 3.1.2
info:
  title: PerfGrid API
  version: 1.0.0
  description: >-
    The PerfGrid customer API. A member creates a token for one billing account
    under *API tokens* in the panel; it can do what both the token's permissions
    and the member's own permissions allow, the same as the panel.


    Send it as `Authorization: Bearer pgapi_...`. Each token may make 120
    requests a minute, of which 30 change something; a `429` response says when
    to try again (`Retry-After`). Ids are the ULIDs the API returns; amounts are
    decimal strings next to their currency; lists are newest first and paged
    with `cursor` (`meta.next_cursor`). Messages are in English, or Danish with
    `Accept-Language: da`.


    The same tokens work with the MCP server at `/mcp` for AI assistants.
servers:
  - url: https://console.perfgrid.com/api/v1
security:
  - http: []
tags:
  - name: Account
  - name: Invoices
  - name: Services
  - name: Domains
  - name: Support
paths:
  /services:
    get:
      tags:
        - Services
      summary: List services
      description: |-
        The billing account's services, newest first: the live ones by
        default, or the ended ones with `status=ended`. Addons are listed on
        their service. Needs `services.view`.
      operationId: v1.services.index
      parameters:
        - name: status
          in: query
          description: '`live` (pending, active or suspended; the default) or `ended`.'
          schema:
            type:
              - string
              - 'null'
            enum:
              - live
              - ended
              - null
      responses:
        '200':
          description: Array of `ServiceResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServiceResource'
                required:
                  - data
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    ServiceResource:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        product:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            type:
              type: string
              enum:
                - grid_hosting
                - static_hosting
                - reseller_hosting
                - cpanel_hosting
                - dns_hosting
                - colocation
                - service_contract
                - other
          required:
            - id
            - name
            - type
        addon:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
        parent_id:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending
            - active
            - suspended
            - terminated
        hostname:
          type:
            - string
            - 'null'
        billing_cycle:
          type: string
          enum:
            - one_time
            - monthly
            - quarterly
            - semi_annually
            - annually
        currency:
          type: string
        price:
          type:
            - string
            - 'null'
        quantity:
          type: integer
        starts_on:
          type:
            - string
            - 'null'
        next_due_date:
          type:
            - string
            - 'null'
        ends_on:
          type:
            - string
            - 'null'
        suspended_at:
          type:
            - string
            - 'null'
        suspension_reason:
          type:
            - string
            - 'null'
          enum:
            - canceled
            - staff
            - overdue
            - null
        terminated_at:
          type:
            - string
            - 'null'
        options:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              type:
                type: string
              customer_changeable:
                type: string
              value:
                type:
                  - object
                  - 'null'
                properties:
                  id:
                    type: string
                  name:
                    type: string
                required:
                  - id
                  - name
              quantity:
                type:
                  - integer
                  - 'null'
              enabled:
                type:
                  - boolean
                  - 'null'
            required:
              - id
              - name
              - type
              - customer_changeable
              - value
              - quantity
              - enabled
        option_discounts:
          type: array
          items:
            type: object
            properties:
              option:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                required:
                  - id
                  - name
              percent:
                type: string
              amount:
                type:
                  - string
                  - 'null'
              ends_on:
                type:
                  - string
                  - 'null'
            required:
              - option
              - percent
              - amount
              - ends_on
        granted_extras:
          type: array
          items:
            type: object
            properties:
              extra:
                type: string
                enum:
                  - disk_gb
                  - addon_domains
              amount:
                type: integer
              ends_on:
                type:
                  - string
                  - 'null'
            required:
              - extra
              - amount
              - ends_on
        addons:
          type: array
          items: {}
        pending_change:
          type:
            - array
            - 'null'
          items: {}
        open_cancellation:
          type:
            - array
            - 'null'
          items: {}
        usage:
          type:
            - object
            - 'null'
          properties:
            disk_used_mb:
              type: integer
            email_disk_used_mb:
              type:
                - integer
                - 'null'
            disk_limit_mb:
              type:
                - integer
                - 'null'
            email_disk_limit_mb:
              type:
                - integer
                - 'null'
            captured_at:
              type:
                - string
                - 'null'
          required:
            - disk_used_mb
            - email_disk_used_mb
            - disk_limit_mb
            - email_disk_limit_mb
            - captured_at
        access:
          type:
            - object
            - 'null'
          properties:
            panel:
              type: object
              properties:
                name:
                  type:
                    - string
                    - 'null'
                  enum:
                    - Hosting panel
                    - cPanel
                    - null
                url:
                  type:
                    - string
                    - 'null'
                username:
                  type:
                    - string
                    - 'null'
              required:
                - name
                - url
                - username
            server:
              type: object
              properties:
                host:
                  type:
                    - string
                    - 'null'
                ipv4:
                  type:
                    - string
                    - 'null'
                ipv6:
                  type:
                    - string
                    - 'null'
                ssh_port:
                  type:
                    - integer
                    - 'null'
              required:
                - host
                - ipv4
                - ipv6
                - ssh_port
            mysql_host:
              type:
                - string
                - 'null'
            mail:
              type: object
              properties:
                in_panel:
                  type: boolean
                host:
                  type:
                    - string
                    - 'null'
                ports:
                  type:
                    - object
                    - 'null'
                  additionalProperties:
                    type: array
                    items:
                      type: integer
                webmail_url:
                  type:
                    - string
                    - 'null'
              required:
                - in_panel
                - host
                - ports
                - webmail_url
            nameservers:
              type: array
              items:
                type: string
            domain_uses_nameservers:
              type:
                - boolean
                - 'null'
            linked_domains:
              type: array
              items: {}
            docs_url:
              type:
                - string
                - 'null'
            getting_started:
              type: array
              items: {}
            notes:
              type: array
              items: {}
          required:
            - panel
            - server
            - mysql_host
            - mail
            - nameservers
            - domain_uses_nameservers
            - linked_domains
            - docs_url
            - getting_started
            - notes
      required:
        - id
        - name
        - product
        - addon
        - parent_id
        - status
        - hostname
        - billing_cycle
        - currency
        - price
        - quantity
        - starts_on
        - next_due_date
        - ends_on
        - suspended_at
        - suspension_reason
        - terminated_at
      title: ServiceResource
  responses:
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    http:
      type: http
      description: >-
        An API token from *API tokens* in the console, sent as `Authorization:
        Bearer pgapi_...`. It works for one billing account, and its permissions
        decide which endpoints it may call.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.