HUhubspot
Basic

Retrieve URL mapping

Changed on

Retrieve a specific URL mapping by its unique identifier. This endpoint is useful for obtaining details about a particular URL mapping configuration within your HubSpot account. It requires the ID of the URL mapping as a path parameter.

get/url-mappings/2026-03/url-mappings/{id}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/url-mappings/2026-03/url-mappings/{id}
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Path parameters

idinteger required

Response

successful operation

cdnPurgeEmbargoTimeinteger required

A Unix timestamp in milliseconds indicating the embargo time for CDN purge related to the URL mapping.

contentGroupIdinteger required

A 64-bit integer representing the content group associated with the URL mapping.

cosObjectType'ACCESS_GROUP_MEMBERSHIP' | 'APP_PAGE' | 'BLOCK' | 'BLOG' | 'BLOG_AUTHOR' | 'BRAND_BUSINESS_UNIT' | 'BRAND_SETTINGS' | 'CONTACT_MEMBERSHIP' | 'CONTENT' | 'CONTENT_EMBED' | 'CONTENT_FOLDER' | 'CONTENT_GROUP' | 'CRM_OBJECT' | 'CRM_OBJECT_TYPE' | 'CUSTOM_WIDGET' | 'CUSTOMER_PORTAL' | 'DATA_QUERY' | 'DESIGN_FOLDER' | 'DOMAIN' | 'DOMAIN_SETTINGS' | 'EMAIL_ADDRESS' | 'EXTENSION_RESOURCE' | 'FILE' | 'FOLDER' | 'FOLLOW_ME' | 'FORM' | 'GLOBAL_CONTENT' | 'HUBDB_TABLE' | 'HUBDB_TABLE_ROW' | 'IMAGE' | 'JS_PROJECT_COMPONENT' | 'KNOWLEDGE_BASE' | 'KNOWLEDGE_CATEGORY' | 'KNOWLEDGE_CATEGORY_TRANSLATION' | 'KNOWLEDGE_HOMEPAGE_CATEGORY' | 'LAYOUT' | 'LAYOUT_SECTION' | 'LIST_MEMBERSHIP' | 'MARKETPLACE_LISTING' | 'PASSWORD_PROTECTED' | 'PAYMENT' | 'PERSONALIZATION_TOKEN' | 'PLACEMENT' | 'PROJECT' | 'QUOTE_TEMPLATE' | 'RAW_ASSET' | 'REDIRECT_URL' | 'SECTION' | 'SERVERLESS_FUNCTION' | 'SITE_MAP' | 'SITE_MENU' | 'SITE_SETTINGS' | 'SUBSCRIPTIONS_SETTINGS' | 'TAG' | 'THEME' | 'THEME_SETTINGS' | 'UNRESTRICTED_ACCESS' | 'URL_MAPPING' | 'VIDEO_PLAYER' | 'WIDGET' | 'WORKFLOW' required

A string representing the type of content object associated with the URL mapping. Valid values include various content types such as 'CONTENT', 'LAYOUT', 'FILE', etc.

createdinteger required

A Unix timestamp in milliseconds indicating when the URL mapping was created.

createdByIdinteger required

The identifier of the user who created the URL mapping.

deletedAtinteger required

A Unix timestamp in milliseconds indicating when the URL mapping was deleted.

destinationstring required

The destination URL to which the routePrefix is redirected.

idinteger required

The unique identifier for the URL mapping, represented as a 64-bit integer.

internallyCreatedboolean required

A boolean indicating if the URL mapping was created internally by the system.

isActiveboolean required

A boolean indicating if the URL mapping is currently active.

isMatchFullUrlboolean required

A boolean indicating if the full URL should be matched.

isMatchQueryStringboolean required

A boolean indicating if the query string should be matched.

isOnlyAfterNotFoundboolean required

A boolean indicating if the mapping should only be applied after a 404 Not Found response.

isPatternboolean required

A boolean indicating if the routePrefix is a pattern.

isProtocolAgnosticboolean required

A boolean indicating if the mapping should ignore the URL protocol (http/https).

isRegexboolean required

A boolean indicating if the routePrefix should be treated as a regular expression.

isTrailingSlashOptionalboolean required

A boolean indicating if the trailing slash in the URL is optional.

labelstring required

A label for the URL mapping.

lastUsedAtinteger required
namestring required

The name of the URL mapping.

notestring required

A string containing notes about the URL mapping.

portalIdinteger required

The identifier for the HubSpot portal associated with this URL mapping.

precedenceinteger required

An integer representing the precedence of the URL mapping, used to determine order of evaluation.

redirectStyleinteger required

An integer representing the style of redirection used.

routePrefixstring required

The prefix of the URL path that is being mapped.

updatedinteger required

A Unix timestamp in milliseconds indicating when the URL mapping was last updated.

updatedByIdinteger required

The identifier of the user who last updated the URL mapping.

Changes

  • b0d8bc008db9Revision changes
    • info

      api operation id get-/url-mappings/2026-03/url-mappings/{id}_/url-mappings/v3/url-mappings/{id} removed and replaced with get-/url-mappings/2026-03/url-mappings/{id}

  • dc2fdad57f7fRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

Some revisions have not been checked yet.