Sites

get site by id

get
Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Query parameters
includestringOptionalExample: account
urlstringOptional
accountIdstringOptionalExample: account_01j1xgme5qeqq97gpdztd7e4a6
enabledbooleanOptional
Responses
chevron-right
200

200

application/json
idstringRequired
__entitystringOptionalExample: Entity
createdAtone ofRequiredExample: 2026-03-27T15:47:09.539Z
string · date-timeOptional
or
string · date-timeOptional
updatedAtone ofRequiredExample: 2026-03-27T15:47:09.539Z
string · date-timeOptional
or
string · date-timeOptional
deletedAtone of · nullableRequiredExample: 2026-03-27T15:47:09.540Z
string · date-timeOptional
or
string · date-timeOptional
accountIdstring · nullableRequiredExample: account_01j1xgme5qeqq97gpdztd7e4a6
titlestring · nullableRequired
descriptionstring · nullableRequired
keywordsstring · nullableRequired
logoany · nullableRequired
faviconany · nullableRequired
backgroundImageany · nullableRequired
domainstringRequired
customDomainstring · nullableRequired
enabledbooleanOptionalDefault: false
messagestring · nullableRequired
withPersonaThemeIdstring · nullableRequired
gaIdsstring[] · nullableRequired
taglinestring · nullableRequired
supportEmailstringRequired
senderEmailstringRequired
trackingPixelCodestring · nullableRequired
conversionPixelCodestring · nullableRequired
demoEmailstring · nullableRequired
demoPasswordstring · nullableRequired
publicOfferingsbooleanOptionalDefault: false
publicPagesbooleanOptionalDefault: false
publicDataRoomsbooleanOptionalDefault: false
get
/clients/api/v1/sites/{id}

query sites by url

get
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault: 1
limitnumber · nullableOptionalDefault: 10
urlstringOptional
accountIdstringOptionalExample: account_01j1xgme5qeqq97gpdztd7e4a6
enabledbooleanOptional
includestringOptionalExample: account
Responses
chevron-right
200

200

application/json
get
/clients/api/v1/sites/

Last updated