Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Get all URL mappings. Supports paging and filtering.
There's a new version of the HubSpot API
Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Get all URL mappings. 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. |
Some parameters support "range" filters via double-underscored param suffixes, like '__gt'. If a parameter supports a filter type of 'gt', that means you can append a double-underscore and 'gt' to the parameter name to find all items greater than a specified value.
For example, the following query will find all items with the 'updated' time greater than 1364424600000: https://api.hubapi.com/url-mappings/v3/url-mappings?hapikey=demo&updated__gt=1364424600000
| Parameter name | Description |
|---|---|
| id | Search for mappings by id. Supports exact value matching and the 'in' range filter (e.g. id__in=348109009,348109019) |
| routePrefix | Search for mappings with a specific routePrefix string value. Must be an exact value match. |
| destination | Search for mappings with a specific destination string value. Must be an exact value match. |
| contentGroupId | Search for mappings created for a specific content group ID (aka blog ID). Must be an exact value match. |
| name | Search for mappings by internal name. Supports exact value matching and the 'in' range filter (e.g. name__in=list-by-author,list-by-topic) |
| isOnlyAfterNotFound | Filter results by this boolean field's value (true, false) |
| isRegex | Filter results by this boolean field's value (true, false) |
| isMatchFullUrl | Filter results by this boolean field's value (true, false) |
| isPattern | Filter results by this boolean field's value (true, false) |
| created | Filter results by creation date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte |
| updated | Filter results by last update date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte |
| deletedAt | Filter results by deletion date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte. Note: Deleted mappings are excluded from results unless this filter is specified. |
| limit | The maximum number of items to return. Defaults to 20. |
| offset | The offset from the beginning of the result set from which to start returning results. Used for paging. Defaults to 0. |
| casing | Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default. This option is provided for backwards-compatibility and ease of migration from Content v2 APIs, which used snake_case. |
| Field name | Type | Description |
|---|---|---|
| id | string | The unique id of the url mapping |
| portalId | string | The hub id |
| created | long | When the url mapping was first created, in milliseconds since the epoch |
| updated | long | When the url mapping was last updated, in milliseconds since the epoch |
| routePrefix | string | The incoming URL, path, or pattern to match |
| destination | string | The URL to redirect to |
| redirectStyle | int | The type of redirect this mapping creates: 301 (permanent) or 302 (temporary) |
| contentGroupId | long | The ID of the content group (aka blog) that this url mapping exists for, if any. Otherwise null. |
| isOnlyAfterNotFound | boolean | If true, the URL mapping will only be applied if a live page matching the URL is not found. If false, the URL mapping will take precedence over any existing page. |
| isRegex | boolean | Deprecated. Indicates whether this mapping was created as a regular expression pattern (this option is no longer supported for new mappings) |
| isMatchFullUrl | boolean | If true, the 'routePrefix' should match on the entire URL including the domain |
| isMatchQueryString | boolean | If true, the 'routePrefix' should match on the entire URL path including the query string |
| isPattern | boolean | If true, this is a flexible pattern based URL Mapping. |
| name | string | An name used to identify the type of pattern this is. Used mostly for blog and other internally-created mappings. |
| precedence | integer | If a URL matches more than one mapping, the one with the lower precedence applies |
| deletedAt | long | When the url mapping was deleted, in milliseconds since the epoch. Zero if the url mapping was never deleted. Use a DELETE request to properly soft delete a url mapping - do not set this value directly. |