> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve all website pages
> Récupérez toutes les pages de site web. Prend en charge la pagination et le filtrage. Cette méthode serait utile pour une intégration qui examine ces modèles et utilise un service externe pour suggérer des modifications.
> **Supported products**
> **Required Scopes**
## OpenAPI
````yaml specs/legacy/v3/cms-pages-v3.json GET /cms/v3/pages/site-pages
openapi: 3.0.1
info:
title: Pages
description: Use these endpoints for interacting with Landing Pages and Site Pages
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
Si vous remarquez qu'une page de site web n'a pas été correctement mise à
jour, utilisez l'API pour afficher les révisions de cette page, puis
rétablissez une version antérieure de la page.
x-hubspot-related-documentation:
- name: Pages Guide
url: https://developers.hubspot.com/docs/guides/api/cms/pages
x-hubspot-introduction: Utilisez l'API des pages pour créer et gérer les pages de site web.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: A/B tests
- name: Advanced
- name: Basic
- name: Batch
- name: Folders
- name: Landing pages
- name: Multi-language
- name: Website pages
paths:
/cms/v3/pages/site-pages:
get:
tags:
- Website pages
summary: Récupérez toutes les pages de site web
description: >-
Récupérez toutes les pages de site web. Prend en charge la pagination et
le filtrage. Cette méthode serait utile pour une intégration qui examine
ces modèles et utilise un service externe pour suggérer des
modifications.
operationId: get-/cms/v3/pages/site-pages_getPage
parameters:
- name: after
in: query
description: "Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON «\_paging.next.after\_» d'une réponse paginée contenant plus de résultats."
required: false
style: form
explode: true
schema:
type: string
- name: archived
in: query
description: "Précise si les pages de site supprimées doivent être affichées. Par défaut, «\_faux\_»."
required: false
style: form
explode: true
schema:
type: boolean
- name: createdAfter
in: query
description: N'affichez que les pages de site créées après l'heure précisée.
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: createdAt
in: query
description: N'affichez que les pages de site créées à l'heure précisée.
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: createdBefore
in: query
description: N'affichez que les pages de site créées avant l'heure précisée.
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: limit
in: query
description: Le nombre maximum de résultats à afficher. Par défaut, 100.
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: property
in: query
description: Spécifie les propriétés des pages de site à inclure dans la réponse.
required: false
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: "Précise les champs à utiliser pour trier les résultats. Les champs valides sont «\_name\_», «\_createdAt\_», «\_updatedAt\_», «\_createdBy\_», «\_updatedBy\_». «\_createdAt\_» sera utilisé par défaut."
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: updatedAfter
in: query
description: >-
N'affichez que les pages de site mises à jour après l'heure
précisée.
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: updatedAt
in: query
description: N'afficher que les pages de site mises à jour à l'heure précisée.
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: updatedBefore
in: query
description: >-
N'affichez que les pages de site mises à jour avant l'heure
précisée.
required: false
style: form
explode: true
schema:
type: string
format: date-time
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: >-
#/components/schemas/CollectionResponseWithTotalPageForwardPaging
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- content
components:
schemas:
CollectionResponseWithTotalPageForwardPaging:
required:
- results
- total
type: object
properties:
paging:
$ref: '#/components/schemas/ForwardPaging'
results:
type: array
description: Collection de pages.
items:
$ref: '#/components/schemas/Page'
total:
type: integer
description: Nombre total de pages.
format: int32
description: Response object for collections of pages with pagination information.
ForwardPaging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
description: "Informations de pagination pour une pagination unidirectionnelle. Contient la référence de la page suivante lorsque d'autres résultats sont disponibles\_; omis ou vide sur la dernière page."
Page:
required:
- abStatus
- abTestId
- archivedAt
- archivedInDashboard
- attachedStylesheets
- authorName
- campaign
- categoryId
- contentGroupId
- contentTypeCategory
- created
- createdById
- currentState
- currentlyPublished
- domain
- dynamicPageDataSourceId
- dynamicPageDataSourceType
- dynamicPageHubDbTableId
- enableDomainStylesheets
- enableLayoutStylesheets
- featuredImage
- featuredImageAltText
- folderId
- footerHtml
- headHtml
- htmlTitle
- id
- includeDefaultCustomCss
- language
- layoutSections
- linkRelCanonicalUrl
- mabExperimentId
- metaDescription
- name
- pageExpiryDate
- pageExpiryEnabled
- pageExpiryRedirectId
- pageExpiryRedirectUrl
- pageRedirected
- password
- publicAccessRules
- publicAccessRulesEnabled
- publishDate
- publishImmediately
- slug
- state
- subcategory
- templatePath
- themeSettingsValues
- translatedFromId
- translations
- updated
- updatedById
- url
- useFeaturedImage
- widgetContainers
- widgets
type: object
properties:
abStatus:
type: string
description: Le statut de l'AB test associé à cette page, le cas échéant
enum:
- automated_loser_variant
- automated_master
- automated_variant
- loser_variant
- mab_master
- mab_variant
- master
- variant
abTestId:
type: string
description: L'ID de l'AB test associé à cette page, le cas échéant
archivedAt:
type: string
description: "L'horodatage (format\_ISO8601) lorsque cette page a été supprimée."
format: date-time
archivedInDashboard:
type: boolean
description: >-
Si Vrai, la page n'apparaîtra pas dans votre tableau de bord, bien
que la page puisse toujours être en ligne.
attachedStylesheets:
type: array
description: >-
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.
items:
type: object
additionalProperties:
type: object
properties: {}
authorName:
type: string
description: Le nom de l'utilisateur qui a mis à jour cette page.
campaign:
type: string
description: Le GUID de la campagne marketing à laquelle cette page est associé.
categoryId:
type: integer
description: ID du type d'objet dont il s'agit. Devrait toujours être.
format: int32
contentGroupId:
type: string
description: L'identifiant unique du groupe de contenu associé à la page.
contentTypeCategory:
type: string
description: >-
Une énumération décrivant le type de cet objet. Doit soit être
LANDING_PAGE, soit SITE_PAGE.
enum:
- '0'
- '1'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '2'
- '20'
- '21'
- '22'
- '3'
- '4'
- '5'
- '6'
- '7'
- '8'
- '9'
created:
type: string
description: L'horodatage indiquant la date de création de la page.
format: date-time
createdById:
type: string
description: L'ID de l'utilisateur qui a créé cette page.
currentState:
type: string
description: Une énumération générée décrivant l'état actuel de cette page.
enum:
- 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:
type: boolean
description: Indique si la page est actuellement publiée.
domain:
type: string
description: >-
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:
type: string
description: >-
L'identifiant de la source de données utilisée par la page
dynamique.
dynamicPageDataSourceType:
type: integer
description: Le type de source de données utilisé par la page dynamique.
format: int32
dynamicPageHubDbTableId:
type: string
description: >-
L'ID de la table HubDB à laquelle cette page fait référence, le cas
échéant.
enableDomainStylesheets:
type: boolean
description: >-
Booléen pour déterminer si les styles du modèle doivent être
appliqués ou non.
enableLayoutStylesheets:
type: boolean
description: >-
Booléen pour déterminer si les styles du modèle doivent être
appliqués ou non.
featuredImage:
type: string
description: L'image en vignette de cette page.
featuredImageAltText:
type: string
description: Texte alternatif de l'image en vignette.
folderId:
type: string
description: >-
L'ID du dossier associé dans lequel cette page de destination est
organisée sur le tableau de bord de l'application.
footerHtml:
type: string
description: >-
HTML personnalisé pour les codes d'intégration, javascript qui doit
être placé avant la balise de la page.
headHtml:
type: string
description: >-
HTML personnalisé pour les codes d'intégration, javascript, etc. qui
va dans la balise