Skip to content
Artbucket

Settings

GET
/api/v1/settings
curl --request GET \
  --url 'http://localhost:3000/api/v1/settings?context=organization' \
  --header 'Authorization: Bearer <token>'

Every setting that can be set in context (organization or project), as it applies there, and its source: set here, inherited from the organization, the server’s environment (config files), or the default. Secret properties come back null, with whether each is set in secrets. Admin on that place.

Any caller; the scope needed is checked on what it acts on.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
context
string
default: organization
Allowed values: organization project

Where

Responses

Section titled “Responses”

200

Section titled “200”

Settings

Media typeapplication/json
object
data
required
Array<object>
object
key
required
string
Allowed values: email branding
label
required
string
context
required
string
Allowed values: organization project
value
required

As it applies here; secret properties are null

object
key
additional properties
secrets
required

Whether each secret property is set

object
key
additional properties
boolean
source
required

The narrowest place any of it comes from

string
Allowed values: project organization environment default
sources
required

Where each property comes from

object
key
additional properties
string
Allowed values: project organization environment default
own
required

Set here: resetting it lets what is above apply

boolean
Example
{
  "data": [
    {
      "key": "email",
      "context": "organization",
      "source": "project",
      "sources": {
        "additionalProperty": "project"
      }
    }
  ]
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}