Get settings

GET

/api/v1/settings/{id}

const url = 'https://example.com/api/v1/settings/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/settings/example

Parameters

Path Parameters

required

string

Query Parameters

expand

string

Responses

200

Settings details

application/json

object

required

Settings ID (15 chars)

string

unit

string

Allowed values: metric imperial

language

Language code

string

bio

string

nullable

mapFocus

string

Allowed values: trails location

location

object

name

string

lat

number

lon

number

category

string

tilesets

Array<object>

nullable

object

name

string

url

string format: uri

terrain

object

terrain

string format: uri

hillshading

string format: uri

user

string

privacy

object

account

string

Allowed values: public private

trails

string

Allowed values: public private

lists

string

Allowed values: public private

created

string format: date-time

updated

string format: date-time

Example

{
  "unit": "metric",
  "mapFocus": "trails",
  "privacy": {
    "account": "public",
    "trails": "public",
    "lists": "public"
  }
}

404

Not Found

500

Internal Server Error