> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: c7a3d3cd-3b52-4456-80d1-e1efc1045637
---
# Retrieve current redirects
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-03/cms-url-redirects-v2026-03.json GET /cms/url-redirects/2026-03
openapi: 3.0.1
info:
title: Url Redirects
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: PROFESSIONAL
sales: FREE
service: FREE
cms: STARTER
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
Redirect one page to another, or redirect an entire blog with one URL using
flexible pattern variables.
x-hubspot-introduction: >-
Use the URL redirects API to redirect traffic from a HubSpot-hosted page or
blog post to any URL. You can redirect pages to specific URLs or use
flexible pattern redirects to redirect multiple pages using variables. Learn
more about managing redirects in HubSpot.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Basic
paths:
/cms/url-redirects/2026-03:
get:
tags:
- Basic
operationId: get-/cms/url-redirects/2026-03_/cms/url-redirects/v3
parameters:
- name: after
in: query
required: false
style: form
explode: true
schema:
type: string
- name: archived
in: query
required: false
style: form
explode: true
schema:
type: boolean
- name: createdAfter
in: query
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: createdAt
in: query
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: createdBefore
in: query
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: limit
in: query
required: false
style: form
explode: true
schema:
type: integer
format: int32
- name: sort
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: updatedAfter
in: query
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: updatedAt
in: query
required: false
style: form
explode: true
schema:
type: string
format: date-time
- name: updatedBefore
in: query
required: false
style: form
explode: true
schema:
type: string
format: date-time
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: >-
#/components/schemas/CollectionResponseWithTotalUrlMappingForwardPaging
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- content
components:
schemas:
CollectionResponseWithTotalUrlMappingForwardPaging:
required:
- results
- total
type: object
properties:
paging:
$ref: '#/components/schemas/ForwardPaging'
results:
type: array
description: >-
An array of UrlMapping objects, each representing a specific URL
mapping.
items:
$ref: '#/components/schemas/UrlMapping'
total:
type: integer
description: The total number of URL mappings available.
format: int32
ForwardPaging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
UrlMapping:
required:
- created
- destination
- id
- isMatchFullUrl
- isMatchQueryString
- isOnlyAfterNotFound
- isPattern
- isProtocolAgnostic
- isTrailingSlashOptional
- precedence
- redirectStyle
- routePrefix
- updated
type: object
properties:
created:
type: string
description: The date and time when the URL mapping was initially created.
format: date-time
destination:
type: string
description: >-
The destination URL, where the target URL should be redirected if it
matches the `routePrefix`.
id:
type: string
description: The unique ID of this URL redirect.
isMatchFullUrl:
type: boolean
description: >-
Whether the `routePrefix` should match on the entire URL, including
the domain.
isMatchQueryString:
type: boolean
description: >-
Whether the `routePrefix` should match on the entire URL path,
including the query string.
isOnlyAfterNotFound:
type: boolean
description: >-
Whether the URL redirect mapping should apply only if a live page on
the URL isn't found. If False, the URL redirect mapping will take
precedence over any existing page.
isPattern:
type: boolean
description: Whether the `routePrefix` should match based on pattern.
isProtocolAgnostic:
type: boolean
description: >-
Whether the `routePrefix` should match both HTTP and HTTPS
protocols.
isTrailingSlashOptional:
type: boolean
description: Whether a trailing slash will be ignored.
precedence:
type: integer
description: >-
Used to prioritize URL redirection. If a given URL matches more than
one redirect, the one with the **lower** precedence will be used.
format: int32
redirectStyle:
type: integer
description: >-
The type of redirect to create. Options include: 301 (permanent),
302 (temporary), or 305 (proxy). Find more details
[here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).
format: int32
routePrefix:
type: string
description: The target incoming URL, path, or pattern to match for redirection.
updated:
type: string
description: The date and time when the URL mapping was last modified.
format: date-time
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: >-
The cursor value indicating where to begin fetching the next page of
results in a paginated collection.
link:
type: string
description: An optional URL for directly accessing the next page of results.
description: >-
Specifies the paging information needed to retrieve the next set of
results in a paginated API response
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
cms-url-redirects-delete: ''
content: ''
````
{product.name} -
{product.level}
)}