---
title: "list settings"
method: GET
path: "/services/{service_id}/settings"
tags: ["Settings"]
---

# list settings

`GET /services/{service_id}/settings`

## Request

- Base URL: `https://api.aptible.com`
- URL: `https://api.aptible.com/services/{service_id}/settings`
- Auth: API key in header `Authorization`

Returns a paginated list of settings for the specified service.

## Path parameters

- `service_id` integer, required

## Query parameters

- `page` integer
- `per_page` integer
- `no_embed` boolean

## Headers

- `Prefer` 'no_sensitive_extras=true'

## Response `200`

successful

- ListSettingsForApp200Response
  - `_embedded` ListSettingsForApp200ResponseEmbedded, required
    - `settings` Setting[]
      - `id` integer, required
      - `_type` string, required
      - `settings` object, required
      - `sensitive_settings` object
      - `_links` ConfigurationLinks
        - `resource` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
        - `self` ListAccountsForStack200ResponseLinksStack
          - `href` string, uri
  - `total_count` integer, required
  - `per_page` integer, required
  - `current_page` integer, required
  - `_links` ListCodeScanResultsForApp200ResponseLinks, required
    - `resource` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `next` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `prev` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri
    - `self` ListAccountsForStack200ResponseLinksStack
      - `href` string, uri

## Other responses

- `default`: Error response. Often a 4xx or 5xx status code

## Changes

- **2026-07-24** `1dc1e5b8c6eb`: 1 breaking, 3 info
  - the response property `_embedded/settings/items/sensitive_settings` became optional for the status `200`
  - added the new optional `header` request parameter `Prefer`
  - added the new optional `query` request parameter `no_embed`
  - added the new optional `query` request parameter `per_page`
- **2026-01-22** `9f13a846724c`: 2 breaking, 2 info
  - removed the required property `_embedded/settings/items/keys` from the response with the `200` status
  - removed the required property `_embedded/settings/items/sensitive_keys` from the response with the `200` status
  - added the required property `_embedded/settings/items/sensitive_settings` to the response with the `200` status
  - added the required property `_embedded/settings/items/settings` to the response with the `200` status
- **2025-11-14** `a0af32b45330`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/aptible/apis/aptible-api-v1/changes/services/:service_id/settings/get.md)

---

[API](https://skmtc.dev/aptible/apis/aptible-api-v1.md) - [All operations](https://skmtc.dev/aptible/apis/aptible-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/aptible/apis/aptible-api-v1/revisions/a21f6b1bc6fe?raw)