Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Get all of your pages. Supports paging and filtering.
There's a new version of the HubSpot API
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Get all of your pages. Supports paging and filtering.
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth Access Token or API Key | Authorization: Bearer {token} header or hapikey={key} query parameter. |
Used to authenticate the request. Please see this page for more details about authentication. |
| Parameter name | Description |
|---|---|
| limit | The number of items to return. Defaults to 20 |
| offset | The offset set to start returning rows from. Defaults to 0. |
| ab_test_id | exact |
| archived | exact |
| campaign | exact |
| created | exact, range, gt, gte, lt, lte |
| deleted_at | exact, gt, lt |
| id | exact, in |
| is_draft | exact |
| name | exact, in, icontains |
| publish_date | exact, range, gt, gte, lt, lte |
| slug | exact, in, icontains |
| subcategory | exact, in |
| updated | exact, range, gt, gte, lt, lte |
Hit this URL with a HTTP method of GET http://api.hubapi.com/content/api/v2/pages?hapikey=demo
| Parameter name | Type | Description |
|---|---|---|
| ab_status | string | An enum with the status of the A/B test - either "master", "variant" or "loser_variant" |
| ab_test_id | string | If this page is an A/B test, this is the unique id for the test. The master, the active variants, and the loser variants, will all have the same ab_test_id |
| archived | bool | If True, the page will not show up in your dashboard, although the page will still be live |
| campaign | string | The guid of the marketing campaign this page is associated with |
| campaign_name | string | The name of the marketing campaign this page is associated with |
| created | long | When the page was first created, in milliseconds since the epoch |
| deleted_at | long | When the page was deleted, in milliseconds since the epoch. Zero if the page was never deleted. Use a DELETE request to delete the page, do not set this directly. |
| footer_html | string | Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page |
| head_html | string | Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page |
| id | string | The unique id of the topic |
| is_draft | string | True if the post is still a draft, invisible to the public. Gets changed when the /publish-action API endpoint is called |
| meta_description | string | A description that goes in <meta> tag on the page |
| meta_keywords | string | Keywords for the meta tag |
| name | string | The internal name of the page |
| password | string | Set this to create a password protected page. Entering the password will be required to view the page |
| publish_date | long | The date the page is to be published at in milliseconds since the unix epoch. |
| publish_immediately | string | Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting |
| slug | string | The path of the URL on which the page will live. Changing this will change the URL. |
| style_override_id | string | The ID of the style to use for this page, set this to use a different style than the default style for the site |
| subcategory | string | This is set to empty or to "landing_page" for landing pages, or to "site_page" for site pages |
| updated | long | When the page was last updated, in milliseconds since the epoch |
| url | string | The full URL with domain and scheme to the page. Will return a 404 if the page is not yet published. |
| widget_containers | string | A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers. |
| widgets | string | A data structure containing the data for all the modules for this page. |