List URL mappings

curl --request GET \
  --url https://api.hubapi.com/url-mappings/v3/url-mappings \
  --header 'Authorization: Bearer <token>'

{
  "objects": [
    {
      "id": 25323248,
      "portalId": 62515,
      "created": 1364424600000,
      "updated": 1486728066193,
      "routePrefix": "http://demo-hubapi.sites.hubspot.com/(?P<page_slug>.*)",
      "destination": "/123456",
      "redirectStyle": 301,
      "contentGroupId": null,
      "isOnlyAfterNotFound": true,
      "isRegex": true,
      "isMatchFullUrl": true,
      "isMatchQueryString": false,
      "isPattern": false,
      "isTrailingSlashOptional": false,
      "isProtocolAgnostic": false,
      "name": "redirect-to-primary",
      "precedence": 1000000005,
      "deletedAt": 0
    },
    {
      "id": 3274869361,
      "portalId": 62515,
      "created": 1441133924669,
      "updated": 1441133924669,
      "routePrefix": "/about-us/contact-us",
      "destination": "/my-api-demo-page-slug",
      "redirectStyle": 301,
      "contentGroupId": null,
      "isOnlyAfterNotFound": true,
      "isRegex": false,
      "isMatchFullUrl": false,
      "isMatchQueryString": false,
      "isPattern": false,
      "isTrailingSlashOptional": false,
      "isProtocolAgnostic": false,
      "name": "",
      "precedence": 1000000010,
      "deletedAt": 0
    }
  ],
  "total": 7,
  "limit": 20,
  "offset": 0,
  "message": null,
  "totalCount": 7
}

GET

url-mappings

List URL mappings

curl --request GET \
  --url https://api.hubapi.com/url-mappings/v3/url-mappings \
  --header 'Authorization: Bearer <token>'

{
  "objects": [
    {
      "id": 25323248,
      "portalId": 62515,
      "created": 1364424600000,
      "updated": 1486728066193,
      "routePrefix": "http://demo-hubapi.sites.hubspot.com/(?P<page_slug>.*)",
      "destination": "/123456",
      "redirectStyle": 301,
      "contentGroupId": null,
      "isOnlyAfterNotFound": true,
      "isRegex": true,
      "isMatchFullUrl": true,
      "isMatchQueryString": false,
      "isPattern": false,
      "isTrailingSlashOptional": false,
      "isProtocolAgnostic": false,
      "name": "redirect-to-primary",
      "precedence": 1000000005,
      "deletedAt": 0
    },
    {
      "id": 3274869361,
      "portalId": 62515,
      "created": 1441133924669,
      "updated": 1441133924669,
      "routePrefix": "/about-us/contact-us",
      "destination": "/my-api-demo-page-slug",
      "redirectStyle": 301,
      "contentGroupId": null,
      "isOnlyAfterNotFound": true,
      "isRegex": false,
      "isMatchFullUrl": false,
      "isMatchQueryString": false,
      "isPattern": false,
      "isTrailingSlashOptional": false,
      "isProtocolAgnostic": false,
      "name": "",
      "precedence": 1000000010,
      "deletedAt": 0
    }
  ],
  "total": 7,
  "limit": 20,
  "offset": 0,
  "message": null,
  "totalCount": 7
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

casing

enum<string>

Use the casing=snake parameter to change the API's casing for all query parameters and JSON fields 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.

Available options:

snake

offset

integer

default:0

The offset from the beginning of the result set from which to start returning results. Used for paging. Defaults to 0.

limit

integer

default:20

The maximum number of items to return. Defaults to 20.

deletedAt

integer

Filter by deletion timestamp, in milliseconds since the epoch. Supports exact value matching and range filters: range, gt, gte, lt, lte.

updated

integer

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.

created

integer

Filter results by creation date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte.

isPattern

boolean

Filter results by this boolean field's value (true, false).

isMatchFullUrl

boolean

If true, the routePrefix should match on the entire URL including the domain.

isRegex

boolean

Filter results by this boolean field's value (true, false).

isOnlyAfterNotFound

boolean

Filter results by this boolean field's value (true, false).

name

string

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).

contentGroupId

integer

Search for mappings created for a specific content group ID (aka blog ID). Must be an exact value match.

destination

string

Search for mappings with a specific destination string value. Must be an exact value match.

routePrefix

string

Search for mappings with a specific routePrefix string value. Must be an exact value match.

integer

Search for mappings by ID. Supports exact value matching and the in range filter (e.g. id__in=348109009,348109019).

Response

successful operation

objects

object[]

Show child attributes

total

integer

Total number of URL mappings

totalCount

integer

Total count of URL mappings

limit

integer

The limit used for this request

offset

integer

The offset used for this request

message

string | null

Optional message