Fetch site settings

GET

/sites/{site_id}/settings

Authorizations

bearerToken|siteContext

bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)

+

siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)

or

siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters

Path Parameters

site_id*

Site identifier (id or subdomain)

Typestring

Required

Responses

settings returned

Content-Type

application/json

{

"name": "string",

"invoice_name": "string",

"invoice_logo": "string",

"shop_address": {

},

"shipping_address": {

},

"default_locale": "string",

"locales": [

"string"

],

"additionalProperties": "string"

}

GET

/sites/{site_id}/settings

Playground

Authorization

bearerToken

siteContext

Variables

Key

Value

site_id*

Samples