List services

Changed on Jul 11, 2025

List all available one-click services.

get/services

Request

Base URL
https://api.dnsimple.com/v2
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/dnsimple/apis/dnsimple-api/docs/services/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

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

Sort results. Default sorting is by id ascending.

Response

Successfully retrieved service list.

Example response

{
  "data": [
    {
      "id": 2,
      "name": "Service 2",
      "sid": "service2",
      "description": "Second service example.",
      "setup_description": null,
      "requires_setup": true,
      "default_subdomain": null,
      "created_at": "2014-02-14T19:15:19Z",
      "updated_at": "2016-03-04T09:23:27Z",
      "settings": [
        {
          "name": "username",
          "label": "Service 2 Account Username",
          "append": ".service2.com",
          "description": "Your Service2 username is used to connect services to your account.",
          "example": "username",
          "password": false
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 2,
    "total_pages": 1
  }
}

Changes

Jul 11, 2025v206780be0ef17 Revision changes
- breaking
  the response property //// became nullable for the status
- info
  the response property became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
Jul 18, 2023v2c8591dcf8c29 Revision changes
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status

Operation history

List services

Request

Query parameters

Response 200OK

Example response

Changes

Response