Skip to content

Get site settings

GET
/teams/{teamId}/domains/{domainId}/settings
curl --request GET \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/settings \
--header 'Authorization: Bearer <token>'

Returns the site’s snippet global, visitor-recovery cookie, first-party cookie mode, consent mode, Global Privacy Control handling and automatic capture.

Required permissions

  • domain:read on all domains, or on the addressed domain when its id is in the route
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

domainId
required

Unique id (UUID) of the site, as returned by the create and list operations.

string format: uuid

Example

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the site, as returned by the create and list operations.

The site’s current settings.

Media typeapplication/json
object
settings
required

How a site’s snippet, cookies and privacy controls behave.

object
tagGlobal
required

Name of the window global the snippet binds, or null for the default qinto (window.qinto).

string | null
fallbackCookie
required

Name of the site’s own cookie Qinto reads to recover a visitor id after its own cookie expires, or null when recovery is off.

string | null
cookieSameSite
required

SameSite mode of the first-party cookie Qinto recognizes returning visitors with. Allowed origins receive it only with none.

string
Allowed values: strict none
consent
required

Consent mode.

object
enabled
required

Whether each event goes only to the apps whose consent category the visitor allowed. Off sends every event to every app.

boolean
gpc
required

Whether a visitor whose browser sends Global Privacy Control is treated as opted out of marketing and sale of data.

boolean
autoCapture
required

Events Qinto captures without the customer instrumenting them.

object
pageLoad
required

Whether Qinto records a page-load event without the customer instrumenting it.

boolean

Example

{
"settings": {
"tagGlobal": "acme",
"fallbackCookie": "_shopify_y",
"cookieSameSite": "strict",
"consent": {
"enabled": true
},
"gpc": true,
"autoCapture": {
"pageLoad": false
}
}
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}