Read project
Read the project’s saved identity and website settings.
GET
/projects/{projectId}Required permission
data:readThe key must include this project and its owner must still have access.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
Response fields
dataobjectRequiredRead the project’s saved identity and website settings.
Child fields
idstringRequiredProject identifier.
workspaceIdstringRequiredOwning workspace.
namestringRequiredProject name.
domainstringRequiredPrimary website domain.
websiteUrlstring | nullRequiredWebsite scope URL.
marketstringRequiredCountry code.
targetStatestring | nullRequiredUS state code, if selected.
languagestringRequiredLanguage code.
brandAliasesstring[]RequiredAdditional brand names.
domainAliasesstring[]RequiredAdditional website domains.
includeSubdomainsbooleanRequiredWhether subdomains are included.
archivedbooleanRequiredWhether the project is archived.
createdAtISO 8601 timestampRequiredWhen the project was created.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.