Developer Portal for YouTrack and Hub Help

Get All Settings


GET <REST API URL>/settings?fields=string&$skip=int&$top=int&query=string




Optional. Returns only the specified subset of the fields for each Setting. Use Fields Syntax to define the subset.


Optional. Lets you set a number of Settings to skip before returning the first one.


Optional. Lets you set the maximum number of Settings to return.


Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Settings, the following fields and tuples are supported:

id: value — Settings with the given ID

type: license — Get license settings

type: public — Get public settings

type: internal — Get internal settings

type: smtp — Get smtp settings

type: backup — Get backup settings


Response Code


200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "settings": [settings, ...] }
Last modified: 27 September 2023