---
title: "REST API: Get URL Mapping"
type: "wiki"
space: "Axero Documentation"
author: "Vladana Garic"
created: 2025-02-05T13:16:08Z
updated: 2026-09-13T00:28:31Z
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/107228/rest-api-get-url-mapping"
---

# REST API: Get URL Mapping

[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=107228)
GET/api/urlmapper

Enables administrators and developers to programmatically retrieve URL mapping details.

## Request

### Request Header
| Header | Required | Value | Description |
| :--- | :--- | :--- | :--- |
| `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens). |
### Required Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `URLID` | Integer | NO | Query | ID of URL Mapper entry you want to get. Either URLID or OldURL must be supplied. |
| `OldURL` | String | NO | Query | The mapped \(old\) URL to look up. Either URLID or OldURL must be supplied. |
## Example

### Request Header

```
Authorization: Bearer YOUR_TOKEN
```

### Request URL

`https://your-site.com/api/urlmapper?urlID=55`

### Success Response

```
{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "UrlID": 55,
    "OldUrl": "https://your-site.com/spaces/291/training-and-development/video/admin/instructional/9457/05-top-level-community-and-spaces",
    "NewUrl": "https://your-site.com/spaces/291/training-and-development/videos/admin/instructional/9457/05-top-level-community-and-spaces",
    "RedirectTypeID": 1,
    "IsActive": true,
    "DateAdded": "2026-09-21T20:34:39.8"
  }
}
```

### Error Response

```
{
  "IsError": true,
  "ResponseMessage": "Not found the url mapper",
  "ResponseData": null
}
```

## Error Handling

| Status Code | Likely Cause | Next Action |
| :--- | :--- | :--- |
| 400 Bad Request | The endpoint does not return this status. Sending neither parameter answers 200 with IsError true instead. | Read IsError on every response rather than the status code. |
| 401 Unauthorized | Missing or invalid Bearer token. | Check token validity. [Learn how to create Bearer tokens →](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) |
| 403 Forbidden | The caller is not a site administrator and lacks the Manage URL Mapper permission. | Call with a site administrator token or grant the permission. |
| 200 with IsError | Neither URLID nor OldURL was sent \(urlID or oldURL must be supplied\), or no mapping matched \(Not found the url mapper\). | Send one of the two and check its value. |
| 500 Server Error | Internal failure. | Retry later. |

## Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

- **Sustained Request Rate:** Do not exceed 5 API calls per second
- **Sequential Processing:** Wait for each request to complete before sending the next in automated workflows
- **Concurrent Connections:** If parallel processing is required, limit to 3 or fewer simultaneous requests
- **Response Timeout:** Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.