List Redirects

  • REST Method: GET
  • URL: https://docsapi.helpscout.net/v1/redirects/site/{siteId}

Use this endpoint to return a list of Redirects for a particular Site

Request

Name Type Required Default Options Notes
page Int No 1    

To request subsequent pages:
https://docsapi.helpscout.net/v1/redirects/site/{siteId}?page=2

Response

Response Name Type Notes
Header Status Int 200
Body page Int Current page that was passed in on the request
  pages Int Total number of pages available
  count Int Total number of objects available
  items Collection Collection of Redirect objects. 
{   
    "page": 1,
    "pages": 1,
    "count": 4,
    "items": [
        {
            "id": "573dfa41951c0e2ad08ab695",
            "siteId": "5244acc53e3e9bd67a3dc68c",
            "urlMapping": "/old/path/1234",
            "documentId": "525217bae4b0cb13e565bb9d",
            "type": "article",
            "redirect": "https://docs.helpscout.net/article/488-transfer-account",
            "anchor": null,
            "createdBy": 4577,
            "modifiedBy": 4577,
            "createdAt": "2016-05-19T17:26:25Z",
            "modifiedAt": "2016-05-19T17:26:25Z"
        },
        {... redirect object ...},
        {... redirect object ...},
        {... redirect object ...}
    ]
}
↑Back to top
© Help Scout 2024