Properties

Sites the key can access.

Generated

This page is generated from api/openapi/v1.yaml (OpenAPI 3.1.0, API version 1.0.0).

List the properties the key can access

GET/v1/properties

Scope: config:read. Test keys only list the demo property.

Parameters

Name	In	Type	Required	Description
limit	query	integer
cursor	query	string		The next_cursor of the previous page.

Responses

Status	Description
200	Properties.
401	Missing, invalid, expired or revoked API key (unauthorized).
402	The plan does not include the feature (plan_required) or a monthly quota is used up (quota_exceeded). required_plan is the cheapest plan that unlocks it.
403	The key lacks the required scope (forbidden_scope).
429	Rate limit exceeded (rate_limited). Wait Retry-After seconds.

Response fields

Field	Type	Required	Description
data	array of object	yes
next_cursor	string | null	yes

Get a property and its settings

GET/v1/properties/{pid}

Scope: config:read.

Parameters

Name	In	Type	Required	Description
pid	path	string	yes	Property id.

Responses

Status	Description
200	The property.
401	Missing, invalid, expired or revoked API key (unauthorized).
403	The key lacks the required scope (forbidden_scope).
404	Unknown endpoint, or a property / object that does not exist or is not accessible with this key (not_found).
429	Rate limit exceeded (rate_limited). Wait Retry-After seconds.

Response fields

Field	Type	Required	Description
id	string
org_id	string
name	string
timezone	string
currency	string
allowed_hostnames	array of string
cross_domains	array of string
consent	object
cnil_exempt	boolean
data_region	"eu" | "us" | "apac"
retention_months	integer
session_timeout_min	integer
archived	boolean