API reference/Redirects

List redirects

Try it

The site's redirect rules (old address → new), with how often each has been used.

GET/api/v1/sites/{site_id}/redirects

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the sites:read scope — read sites, pages and sections.

sites:readRead onlyMCP tool: list_redirects

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required: The site's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/redirects' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "from_path": {
            "type": "string",
            "description": "The old address, normalised: lower-case, no query, no trailing slash."
          },
          "to": {
            "type": "string",
            "description": "A path on the site or a full https:// address."
          },
          "status_code": {
            "anyOf": [
              {
                "type": "number",
                "const": 301
              },
              {
                "type": "number",
                "const": 302
              }
            ]
          },
          "hits": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991,
            "description": "How many visitors it has sent on (about)."
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "from_path",
          "to",
          "status_code",
          "hits",
          "created_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}