---
title: "Retrieve a service"
method: GET
path: "/services/{service}"
tags: ["domain services"]
---

# Retrieve a service

`GET /services/{service}`

Retrieves the details of a one-click service.

## Path parameters

- `service` string, required

## Response `200`

Successfully retrieved service.

- 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)

## Other responses

- `404` — The requested resource doesn't exist.

## Changes

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

[Change history](https://skmtc.dev/dnsimple/apis/dnsimple-api/changes/services/:service/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/2e2a96fa71fe/schema)