Passer au contenu principal
GET
/
cms
/
v3
/
pages
/
site-pages
/
{objectId}
Récupérer une page de site web
curl --request GET \
  --url https://api.hubapi.com/cms/v3/pages/site-pages/{objectId} \
  --header 'Authorization: Bearer <token>'
{
  "abStatus": "automated_loser_variant",
  "abTestId": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z",
  "archivedInDashboard": true,
  "attachedStylesheets": [
    {}
  ],
  "authorName": "<string>",
  "campaign": "<string>",
  "categoryId": 123,
  "contentGroupId": "<string>",
  "contentTypeCategory": "0",
  "created": "2023-11-07T05:31:56Z",
  "createdById": "<string>",
  "currentState": "AGENT_GENERATED",
  "currentlyPublished": true,
  "domain": "<string>",
  "dynamicPageDataSourceId": "<string>",
  "dynamicPageDataSourceType": 123,
  "dynamicPageHubDbTableId": "<string>",
  "enableDomainStylesheets": true,
  "enableLayoutStylesheets": true,
  "featuredImage": "<string>",
  "featuredImageAltText": "<string>",
  "folderId": "<string>",
  "footerHtml": "<string>",
  "headHtml": "<string>",
  "htmlTitle": "<string>",
  "id": "<string>",
  "includeDefaultCustomCss": true,
  "language": "aa",
  "layoutSections": {},
  "linkRelCanonicalUrl": "<string>",
  "mabExperimentId": "<string>",
  "metaDescription": "<string>",
  "name": "<string>",
  "pageExpiryDate": 123,
  "pageExpiryEnabled": true,
  "pageExpiryRedirectId": 123,
  "pageExpiryRedirectUrl": "<string>",
  "pageRedirected": true,
  "password": "<string>",
  "publicAccessRules": [
    {}
  ],
  "publicAccessRulesEnabled": true,
  "publishDate": "2023-11-07T05:31:56Z",
  "publishImmediately": true,
  "slug": "<string>",
  "state": "<string>",
  "subcategory": "<string>",
  "templatePath": "<string>",
  "themeSettingsValues": {},
  "translatedFromId": "<string>",
  "translations": {},
  "updated": "2023-11-07T05:31:56Z",
  "updatedById": "<string>",
  "url": "<string>",
  "useFeaturedImage": true,
  "widgetContainers": {},
  "widgets": {}
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

objectId
string
requis

Paramètres de requête

archived
boolean

S'il faut renvoyer uniquement les résultats qui ont été archivés.

property
string

Réponse

successful operation

Model definition for a landing page or site page.

abStatus
enum<string>
requis

Le statut de l'AB test associé à cette page, le cas échéant

Options disponibles:
automated_loser_variant,
automated_master,
automated_variant,
loser_variant,
mab_master,
mab_variant,
master,
variant
abTestId
string
requis

L'ID de l'AB test associé à cette page, le cas échéant

archivedAt
string<date-time>
requis

L'horodatage (format ISO8601) lorsque cette page a été supprimée.

archivedInDashboard
boolean
requis

Si Vrai, la page n'apparaîtra pas dans votre tableau de bord, bien que la page puisse toujours être en ligne.

attachedStylesheets
object[]
requis

Liste des feuilles de style à joindre à cette page. Ces feuilles de style sont attachées uniquement à cette page. L'ordre de préséance est de bas en haut, comme dans le HTML.

authorName
string
requis

Le nom de l'utilisateur qui a mis à jour cette page.

campaign
string
requis

Le GUID de la campagne marketing à laquelle cette page est associé.

categoryId
integer<int32>
requis

ID du type d'objet dont il s'agit. Devrait toujours être.

contentGroupId
string
requis

L'identifiant unique du groupe de contenu associé à la page.

contentTypeCategory
enum<string>
requis

Une énumération décrivant le type de cet objet. Doit soit être LANDING_PAGE, soit SITE_PAGE.

Options disponibles:
0,
1,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
2,
20,
21,
22,
3,
4,
5,
6,
7,
8,
9
created
string<date-time>
requis

L'horodatage indiquant la date de création de la page.

createdById
string
requis

L'ID de l'utilisateur qui a créé cette page.

currentState
enum<string>
requis

Une énumération générée décrivant l'état actuel de cette page.

Options disponibles:
AGENT_GENERATED,
AUTOMATED,
AUTOMATED_AB,
AUTOMATED_AB_VARIANT,
AUTOMATED_DRAFT,
AUTOMATED_DRAFT_AB,
AUTOMATED_DRAFT_ABVARIANT,
AUTOMATED_FOR_FORM,
AUTOMATED_FOR_FORM_BUFFER,
AUTOMATED_FOR_FORM_DRAFT,
AUTOMATED_FOR_FORM_LEGACY,
AUTOMATED_LOSER_ABVARIANT,
AUTOMATED_SENDING,
BLOG_EMAIL_DRAFT,
BLOG_EMAIL_PUBLISHED,
DRAFT,
DRAFT_AB,
DRAFT_AB_VARIANT,
ERROR,
LOSER_AB_VARIANT,
PAGE_STUB,
PRE_PROCESSING,
PROCESSING,
PUBLISHED,
PUBLISHED_AB,
PUBLISHED_AB_VARIANT,
PUBLISHED_OR_SCHEDULED,
RSS_TO_EMAIL_DRAFT,
RSS_TO_EMAIL_PUBLISHED,
SCHEDULED,
SCHEDULED_AB,
SCHEDULED_OR_PUBLISHED
currentlyPublished
boolean
requis

Indique si la page est actuellement publiée.

domain
string
requis

Le domaine vers lequel renverra cette page. S'il n'est pas valide, la page renverra par défaut vers le domaine principal pour ce type de contenu.

dynamicPageDataSourceId
string
requis

L'identifiant de la source de données utilisée par la page dynamique.

dynamicPageDataSourceType
integer<int32>
requis

Le type de source de données utilisé par la page dynamique.

dynamicPageHubDbTableId
string
requis

L'ID de la table HubDB à laquelle cette page fait référence, le cas échéant.

enableDomainStylesheets
boolean
requis

Booléen pour déterminer si les styles du modèle doivent être appliqués ou non.

enableLayoutStylesheets
boolean
requis

Booléen pour déterminer si les styles du modèle doivent être appliqués ou non.

L'image en vignette de cette page.

Texte alternatif de l'image en vignette.

folderId
string
requis

L'ID du dossier associé dans lequel cette page de destination est organisée sur le tableau de bord de l'application.

HTML personnalisé pour les codes d'intégration, javascript qui doit être placé avant la balise de la page.

headHtml
string
requis

HTML personnalisé pour les codes d'intégration, javascript, etc. qui va dans la balise de la page.

htmlTitle
string
requis

Le titre html de cette page.

id
string
requis

L'ID unique de la page.

includeDefaultCustomCss
boolean
requis

Booléen pour déterminer si les fichiers CSS principaux doivent être appliqués ou non.

language
enum<string>
requis

Le code de langue ISO 639 explicitement défini de la page. Si nul, la page utilisera par défaut la langue du domaine.

Options disponibles:
aa,
ab,
ae,
af,
af-na,
af-za,
agq,
agq-cm,
ak,
ak-gh,
am,
am-et,
an,
ann,
ann-ng,
ar,
ar-001,
ar-ae,
ar-bh,
ar-dj,
ar-dz,
ar-eg,
ar-eh,
ar-er,
ar-il,
ar-iq,
ar-jo,
ar-km,
ar-kw,
ar-lb,
ar-ly,
ar-ma,
ar-mr,
ar-om,
ar-ps,
ar-qa,
ar-sa,
ar-sd,
ar-so,
ar-ss,
ar-sy,
ar-td,
ar-tn,
ar-ye,
as,
as-in,
asa,
asa-tz,
ast,
ast-es,
av,
ay,
az,
az-az,
ba,
bas,
bas-cm,
be,
be-by,
bem,
bem-zm,
bez,
bez-tz,
bg,
bg-bg,
bgc,
bgc-in,
bho,
bho-in,
bi,
bm,
bm-ml,
bn,
bn-bd,
bn-in,
bo,
bo-cn,
bo-in,
br,
br-fr,
brx,
brx-in,
bs,
bs-ba,
ca,
ca-ad,
ca-es,
ca-fr,
ca-it,
ccp,
ccp-bd,
ccp-in,
ce,
ce-ru,
ceb,
ceb-ph,
cgg,
cgg-ug,
ch,
chr,
chr-us,
ckb,
ckb-iq,
ckb-ir,
co,
cr,
cs,
cs-cz,
cu,
cu-ru,
cv,
cv-ru,
cy,
cy-gb,
da,
da-dk,
da-gl,
dav,
dav-ke,
de,
de-at,
de-be,
de-ch,
de-de,
de-gr,
de-it,
de-li,
de-lu,
dje,
dje-ne,
doi,
doi-in,
dsb,
dsb-de,
dua,
dua-cm,
dv,
dyo,
dyo-sn,
dz,
dz-bt,
ebu,
ebu-ke,
ee,
ee-gh,
ee-tg,
el,
el-cy,
el-gr,
en,
en-001,
en-150,
en-ae,
en-ag,
en-ai,
en-as,
en-at,
en-au,
en-bb,
en-be,
en-bi,
en-bm,
en-bs,
en-bw,
en-bz,
en-ca,
en-cc,
en-ch,
en-ck,
en-cm,
en-cn,
en-cx,
en-cy,
en-de,
en-dg,
en-dk,
en-dm,
en-ee,
en-eg,
en-er,
en-es,
en-fi,
en-fj,
en-fk,
en-fm,
en-fr,
en-gb,
en-gd,
en-gg,
en-gh,
en-gi,
en-gm,
en-gu,
en-gy,
en-hk,
en-id,
en-ie,
en-il,
en-im,
en-in,
en-io,
en-je,
en-jm,
en-ke,
en-ki,
en-kn,
en-ky,
en-lc,
en-lr,
en-ls,
en-lu,
en-mg,
en-mh,
en-mo,
en-mp,
en-ms,
en-mt,
en-mu,
en-mv,
en-mw,
en-mx,
en-my,
en-na,
en-nf,
en-ng,
en-nl,
en-nr,
en-nu,
en-nz,
en-pg,
en-ph,
en-pk,
en-pn,
en-pr,
en-pt,
en-pw,
en-rw,
en-sb,
en-sc,
en-sd,
en-se,
en-sg,
en-sh,
en-si,
en-sl,
en-ss,
en-sx,
en-sz,
en-tc,
en-th,
en-tk,
en-tn,
en-to,
en-tt,
en-tv,
en-tz,
en-ug,
en-um,
en-us,
en-vc,
en-vg,
en-vi,
en-vn,
en-vu,
en-ws,
en-za,
en-zm,
en-zw,
eo,
eo-001,
es,
es-419,
es-ar,
es-bo,
es-br,
es-bz,
es-cl,
es-co,
es-cr,
es-cu,
es-do,
es-ea,
es-ec,
es-es,
es-gq,
es-gt,
es-hn,
es-ic,
es-mx,
es-ni,
es-pa,
es-pe,
es-ph,
es-pr,
es-py,
es-sv,
es-us,
es-uy,
es-ve,
et,
et-ee,
eu,
eu-es,
ewo,
ewo-cm,
fa,
fa-af,
fa-ir,
ff,
ff-bf,
ff-cm,
ff-gh,
ff-gm,
ff-gn,
ff-gw,
ff-lr,
ff-mr,
ff-ne,
ff-ng,
ff-sl,
ff-sn,
fi,
fi-fi,
fil,
fil-ph,
fj,
fo,
fo-dk,
fo-fo,
fr,
fr-be,
fr-bf,
fr-bi,
fr-bj,
fr-bl,
fr-ca,
fr-cd,
fr-cf,
fr-cg,
fr-ch,
fr-ci,
fr-cm,
fr-dj,
fr-dz,
fr-fr,
fr-ga,
fr-gf,
fr-gn,
fr-gp,
fr-gq,
fr-ht,
fr-km,
fr-lu,
fr-ma,
fr-mc,
fr-mf,
fr-mg,
fr-ml,
fr-mq,
fr-mr,
fr-mu,
fr-nc,
fr-ne,
fr-pf,
fr-pm,
fr-re,
fr-rw,
fr-sc,
fr-sn,
fr-sy,
fr-td,
fr-tg,
fr-tn,
fr-vu,
fr-wf,
fr-yt,
frr,
frr-de,
fur,
fur-it,
fy,
fy-nl,
ga,
ga-gb,
ga-ie,
gd,
gd-gb,
gl,
gl-es,
gn,
gsw,
gsw-ch,
gsw-fr,
gsw-li,
gu,
gu-in,
guz,
guz-ke,
gv,
gv-im,
ha,
ha-gh,
ha-ne,
ha-ng,
haw,
haw-us,
he,
he-il,
hi,
hi-in,
hmn,
ho,
hr,
hr-ba,
hr-hr,
hsb,
hsb-de,
ht,
hu,
hu-hu,
hy,
hy-am,
hz,
ia,
ia-001,
id,
id-id,
ie,
ig,
ig-ng,
ii,
ii-cn,
ik,
io,
is,
is-is,
it,
it-ch,
it-it,
it-sm,
it-va,
iu,
ja,
ja-jp,
jgo,
jgo-cm,
jmc,
jmc-tz,
jv,
jv-id,
ka,
ka-ge,
kab,
kab-dz,
kam,
kam-ke,
kar,
kde,
kde-tz,
kea,
kea-cv,
kg,
kgp,
kgp-br,
kh,
khq,
khq-ml,
ki,
ki-ke,
kj,
kk,
kk-kz,
kkj,
kkj-cm,
kl,
kl-gl,
kln,
kln-ke,
km,
km-kh,
kn,
kn-in,
ko,
ko-kp,
ko-kr,
kok,
kok-in,
kr,
ks,
ks-in,
ksb,
ksb-tz,
ksf,
ksf-cm,
ksh,
ksh-de,
ku,
ku-tr,
kv,
kw,
kw-gb,
ky,
ky-kg,
la,
lag,
lag-tz,
lb,
lb-lu,
lg,
lg-ug,
li,
lkt,
lkt-us,
ln,
ln-ao,
ln-cd,
ln-cf,
ln-cg,
lo,
lo-la,
lrc,
lrc-iq,
lrc-ir,
lt,
lt-lt,
lu,
lu-cd,
luo,
luo-ke,
luy,
luy-ke,
lv,
lv-lv,
mai,
mai-in,
mas,
mas-ke,
mas-tz,
mdf,
mdf-ru,
mer,
mer-ke,
mfe,
mfe-mu,
mg,
mg-mg,
mgh,
mgh-mz,
mgo,
mgo-cm,
mh,
mi,
mi-nz,
mk,
mk-mk,
ml,
ml-in,
mn,
mn-mn,
mni,
mni-in,
mr,
mr-in,
ms,
ms-bn,
ms-id,
ms-my,
ms-sg,
mt,
mt-mt,
mua,
mua-cm,
my,
my-mm,
mzn,
mzn-ir,
na,
naq,
naq-na,
nb,
nb-no,
nb-sj,
nd,
nd-zw,
nds,
nds-de,
nds-nl,
ne,
ne-in,
ne-np,
ng,
nl,
nl-aw,
nl-be,
nl-bq,
nl-ch,
nl-cw,
nl-lu,
nl-nl,
nl-sr,
nl-sx,
nmg,
nmg-cm,
nn,
nn-no,
nnh,
nnh-cm,
no,
no-no,
nr,
nus,
nus-ss,
nv,
ny,
nyn,
nyn-ug,
oc,
oc-es,
oc-fr,
oj,
om,
om-et,
om-ke,
or,
or-in,
os,
os-ge,
os-ru,
pa,
pa-in,
pa-pk,
pcm,
pcm-ng,
pi,
pis,
pis-sb,
pl,
pl-pl,
prg,
prg-001,
ps,
ps-af,
ps-pk,
pt,
pt-ao,
pt-br,
pt-ch,
pt-cv,
pt-gq,
pt-gw,
pt-lu,
pt-mo,
pt-mz,
pt-pt,
pt-st,
pt-tl,
qu,
qu-bo,
qu-ec,
qu-pe,
raj,
raj-in,
rm,
rm-ch,
rn,
rn-bi,
ro,
ro-md,
ro-ro,
rof,
rof-tz,
ru,
ru-by,
ru-kg,
ru-kz,
ru-md,
ru-ru,
ru-ua,
rw,
rw-rw,
rwk,
rwk-tz,
sa,
sa-in,
sah,
sah-ru,
saq,
saq-ke,
sat,
sat-in,
sbp,
sbp-tz,
sc,
sc-it,
sd,
sd-in,
sd-pk,
se,
se-fi,
se-no,
se-se,
seh,
seh-mz,
ses,
ses-ml,
sg,
sg-cf,
shi,
shi-ma,
si,
si-lk,
sk,
sk-sk,
sl,
sl-si,
sm,
smn,
smn-fi,
sms,
sms-fi,
sn,
sn-zw,
so,
so-dj,
so-et,
so-ke,
so-so,
sq,
sq-al,
sq-mk,
sq-xk,
sr,
sr-ba,
sr-cs,
sr-me,
sr-rs,
sr-xk,
ss,
st,
su,
su-id,
sv,
sv-ax,
sv-fi,
sv-se,
sw,
sw-cd,
sw-ke,
sw-tz,
sw-ug,
sy,
ta,
ta-in,
ta-lk,
ta-my,
ta-sg,
te,
te-in,
teo,
teo-ke,
teo-ug,
tg,
tg-tj,
th,
th-th,
ti,
ti-er,
ti-et,
tk,
tk-tm,
tl,
tn,
to,
to-to,
tok,
tok-001,
tr,
tr-cy,
tr-tr,
ts,
tt,
tt-ru,
tw,
twq,
twq-ne,
ty,
tzm,
tzm-ma,
ug,
ug-cn,
uk,
uk-ua,
ur,
ur-in,
ur-pk,
uz,
uz-af,
uz-uz,
vai,
vai-lr,
ve,
vi,
vi-vn,
vo,
vo-001,
vun,
vun-tz,
wa,
wae,
wae-ch,
wo,
wo-sn,
xh,
xh-za,
xog,
xog-ug,
yav,
yav-cm,
yi,
yi-001,
yo,
yo-bj,
yo-ng,
yrl,
yrl-br,
yrl-co,
yrl-ve,
yue,
yue-cn,
yue-hk,
za,
zgh,
zgh-ma,
zh,
zh-cn,
zh-hans,
zh-hant,
zh-hk,
zh-mo,
zh-sg,
zh-tw,
zu,
zu-za
layoutSections
object
requis

Une structure détaillant les sections de mise en page de la page.

Option de remplacement pour définir l'URL à utiliser dans la balise de lien rel=canonical sur la page.

mabExperimentId
string
requis

L'ID du MAB test (ou test dynamique) associé à cette page, le cas échéant

metaDescription
string
requis

Une description qui va dans la balise de la page.

name
string
requis

Le nom interne de la page.

pageExpiryDate
integer<int64>
requis

La date à laquelle cette page doit expirer et commencer à rediriger vers une autre URL ou page.

pageExpiryEnabled
boolean
requis

Booléen indiquant si la fonctionnalité d'expiration de page est activée pour cette page

pageExpiryRedirectId
integer<int64>
requis

L'ID d'une autre page vers laquelle l'URL de cette page doit rediriger une fois cette page, est arrivée à expiration. Doit seulement être réglé sur cela ou sur pageExpiryRedirectUrl.

pageExpiryRedirectUrl
string
requis

L'ID de l'URL vers laquelle l'URL de cette page doit rediriger une fois cette page, est arrivée à expiration. Doit seulement être réglé sur cela ou sur pageExpiryRedirectId.

pageRedirected
boolean
requis

Un booléen généré indiquant si cette page est arrivée à expiration et en cours de redirection.

password
string
requis

Définissez ceci pour créer une page protégée par mot de passe. Entrer le mot de passe sera nécessaire pour visualiser la page.

publicAccessRules
object[]
requis

Règles pour exiger l'inscription des membres pour accéder au contenu privé.

publicAccessRulesEnabled
boolean
requis

Booléen pour déterminer s'il faut respecter ou non les règles d'accès public.

publishDate
string<date-time>
requis

La date (format ISO8601) à laquelle la page doit être publiée.

publishImmediately
boolean
requis

Définissez ceci sur vrai si vous souhaitez être publié immédiatement lorsque le point de terminaison de publication planifiée est appelé, et pour ignorer le paramètre publish_date.

slug
string
requis

Le chemin de cette page. Ce champ est ajouté au domaine pour construire l'URL de cette page.

state
string
requis

Une énumération décrivant l'état actuel de cette page.

Maximum string length: 25
subcategory
string
requis

Détails du type de page dont il s'agit. Doit toujours être landing_page ou site_page

templatePath
string
requis

Chaîne détaillant le chemin du modèle utilisé pour cette page.

themeSettingsValues
object
requis

Un ensemble de paramètres spécifiques au thème appliqué à la page.

translatedFromId
string
requis

ID de la page principale à partir de laquelle cet objet a été traduit.

translations
object
requis

Une carte des traductions de la page, chacune associée à une variante linguistique spécifique.

updated
string<date-time>
requis

L'horodatage indiquant le moment où la page a été mise à jour pour la dernière fois.

updatedById
string
requis

L'ID de l'utilisateur qui a mis à jour cette page.

url
string
requis

Un champ généré représentant l'URL de cette page.

Booléen pour déterminer si cette page doit utiliser une image en vignette.

widgetContainers
object
requis

Une structure de données contenant les données de tous les modules à l'intérieur des conteneurs pour cette page. Elle ne sera remplie que si la page contient des conteneurs de widgets.

widgets
object
requis

Une structure de données contenant les données de tous les modules pour cette page.

Last modified on March 30, 2026