# List URLForwardings

Returns all URL forwarding settings configured for a domain.

Endpoint: GET /core/v1/domains/{domainName}/url/forwarding
Version: 1.3.1
Security: BasicAuth

## Path parameters:

  - `domainName` (string, required)
    DomainName is the domain to list URL forwarding entries for.
    Example: "example.com"

## Query parameters:

  - `perPage` (integer)
    Per Page is the number of records to return per request. Per Page defaults to 1,000.
    Example: 100

  - `page` (integer)
    Page is which page to return. Starts at 1 for first page.
    Example: 1

## Response 200 fields (application/json):

  - `lastPage` (integer,null)
    LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
    Example: 5

  - `nextPage` (integer,null)
    NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
    Example: 2

  - `urlForwarding` (array, required)
    URLForwarding is the list of URL forwarding entries.
    Example: []

  - `urlForwarding.domainName` (string)
    The domain name (without subdomains) that is being forwarded.
    Example: "example.org"

  - `urlForwarding.forwardsTo` (string, required)
    The destination URL to which this hostname will be forwarded.
    Example: "https://destination-site.com"

  - `urlForwarding.host` (string, required)
    The subdomain portion of the hostname that is being forwarded.
    Example: "www.example.org"

  - `urlForwarding.meta` (string,null)
    Meta tags to include in the HTML page when using "masked" forwarding.
Ignored for other forwarding types.
Example: ``
    Example: "<meta name='keywords' content='website, forwarding, masked'>"

  - `urlForwarding.title` (string,null)
    The title to be used for the HTML page when using "masked" forwarding.
Ignored for other forwarding types.
    Example: "Welcome to my forwarded website"

  - `urlForwarding.type` (string, required)
    The type of URL forwarding. Valid values:
  - : Retains the original domain in the address bar, preventing the user from seeing the actual destination URL. Sometimes called iframe forwarding.
  - : Uses a standard HTTP redirect (301), which changes the address bar to the destination URL.
  - : Uses a temporary HTTP redirect (302), which changes the address bar to the destination URL but indicates the resource is temporarily located elsewhere.
    Enum: "masked", "redirect", "302"

## Response 400 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Bad Request"

  - `details` (string,null)
    Additional context or information about the error
    Example: "'domainName' cannot be null"

## Response 401 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Unauthorized"

## Response 403 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Permission denied"

  - `details` (string,null)
    Additional context or information about the error
    Example: "Failed authentication"

## Response 404 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error
    Example: "Not Found"

  - `details` (string,null)
    Additional context or information about the error
    Example: "The requested domain does not exist."

## Response 429 fields (application/json):

  - `message` (string)
    A human-readable message providing more details about the error
    Example: "Rate Limit Exceeded"

## Response 500 fields (application/json):

  - `message` (string, required)
    A human-readable message providing more details about the error.
    Example: "Internal Server Error"

  - `details` (string,null)
    Additional context or information about the error.
    Example: "Something went wrong."