---
title: "List services"
method: GET
path: "/services"
tags: ["domain services"]
---

# List services

`GET /services`

List all available one-click services.

## Query parameters

- `sort` 'id:asc' | 'id:desc' | 'sid:asc' | 'sid:desc'

## Response `200`

Successfully retrieved service list.

- object
  - `data` Service[]
    - `id` integer — A unique identifier
    - `name` string — A human-readable name
    - `sid` string — A string identifier that can be used in URLs (always lowercase)
    - `description` string — A human-readable description of the one-click service
    - `setup_description` string, nullable — Describes setup requirements
    - `requires_setup` boolean — Flag indicating whether setup is required
    - `default_subdomain` string, nullable — The default subdomain used when creating DNS records
    - `created_at` string, date-time — A date-time value formatted as ISO 8601.
    - `updated_at` string, date-time — A date-time value formatted as ISO 8601.
    - `settings` ServiceSetting[]
      - `name` string — The form name for the setting
      - `label` string — The human-readable label value
      - `append` string — Additional text to append to the input field
      - `description` string — Description of the setting
      - `example` string — An example value
      - `password` boolean — true if the value is a password (and thus should not be visible in the field)
  - `pagination` Pagination
    - `current_page` integer
    - `per_page` integer
    - `total_entries` integer
    - `total_pages` integer

## Changes

- **2023-07-18** (v2) `c8591dcf8c29` — 24 breaking
  - the response property `data/items/default_subdomain` became nullable for the status `200`
  - the response property `data/items/setup_description` became nullable for the status `200`
  - the response property `data` became optional for the status `200`
  - the response property `data/items/created_at` became optional for the status `200`
  - …20 more

[Change history](https://skmtc.dev/dnsimple/apis/dnsimple-api/changes/services/get.md)

---

[API](https://skmtc.dev/dnsimple/apis/dnsimple-api.md) · [All operations](https://skmtc.dev/dnsimple/apis/dnsimple-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dnsimple/dnsimple-api/revisions/b50d4f643cbd/schema)