---
updatedAt: 2026-06-22T06:24:00.000Z
agentTools:
  projectIndex: https://developers.rebrandly.com/llms.txt
---

# Get Revoked Items

List revoked workspaces, domains, and features.

# OpenAPI definition

````json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Rebrandly API",
    "description": "# Rebrandly API Documentation\n\nThe Rebrandly API allows you to programmatically create, update, and manage your branded short links,\ncustom domains, workspaces, and analytics.\n\n## Base URL\n\nAll API requests should be made to:\n```\nhttps://api.rebrandly.com/v1\n```\n\n## Authentication\n\nThe Rebrandly API uses API keys for authentication. You can obtain your API key from your\n[Rebrandly account settings](https://app.rebrandly.com/account/api-keys).\n\nInclude your API key in the request header:\n```\napikey: YOUR_API_KEY\n```\n\n## Rate Limiting\n\nAPI requests are rate-limited based on your subscription plan. Rate limit information is included\nin response headers:\n- `X-RateLimit-Limit`: Total requests allowed per period\n- `X-RateLimit-Remaining`: Requests remaining in current period\n- `X-RateLimit-Reset`: Time when the rate limit resets (Unix timestamp)\n\n## Multi-Tenancy and Workspaces\n\nMost Rebrandly API resources (links, domains, scripts, tags) are organized into **Workspaces**.\nTo access resources in a specific workspace, you must include the `Workspace` header with the workspace's unique ID.\n\n```\nWorkspace: YOUR_WORKSPACE_ID\n```\n\nIf the `Workspace` header is omitted, the request will be processed in your **Default Workspace**.\n",
    "version": "7.0.2",
    "contact": {
      "name": "Rebrandly Team",
      "email": "dev@rebrandly.com"
    },
    "license": {
      "name": "Proprietary"
    }
  },
  "servers": [
    {
      "url": "https://api.rebrandly.com/v1",
      "description": "Production API"
    }
  ],
  "paths": {
    "/entitlements/revoked": {
      "get": {
        "summary": "Get Revoked Items",
        "description": "List revoked workspaces, domains, and features.",
        "operationId": "getRevokedEntitlements",
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiKeyHeader"
          }
        ],
        "responses": {
          "200": {
            "description": "Revoked items",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "workspaces": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Workspace"
                      }
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Domain"
                      }
                    },
                    "features": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Feature"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "apiKey": []
          }
        ],
        "tags": [
          "Entitlements"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Entitlements",
      "description": "Account entitlements and usage limits."
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "apikey",
        "description": "Rebrandly API key for authentication"
      }
    },
    "parameters": {
      "ApiKeyHeader": {
        "name": "apikey",
        "in": "header",
        "required": true,
        "description": "API key for authentication",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "Workspace": {
        "type": "object",
        "required": [
          "id",
          "name",
          "type",
          "createdAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Workspace public ID",
            "example": "workspace123abc"
          },
          "name": {
            "type": "string",
            "description": "Workspace name",
            "example": "My Workspace"
          },
          "avatarUrl": {
            "type": "string",
            "description": "Workspace avatar URL"
          },
          "links": {
            "type": "integer",
            "description": "Number of links in workspace"
          },
          "teammates": {
            "type": "integer",
            "description": "Number of teammates in workspace"
          },
          "domains": {
            "type": "integer",
            "description": "Number of domains in workspace"
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "email": {
                "type": "string"
              }
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "enum": [
              "classic",
              "extended",
              "gallery"
            ]
          },
          "default": {
            "type": "boolean"
          },
          "revoked": {
            "type": "boolean"
          },
          "role": {
            "type": "string",
            "enum": [
              "owner",
              "admin",
              "user",
              "guest",
              "viewer"
            ]
          },
          "clicks": {
            "type": "integer"
          },
          "sessions": {
            "type": "integer"
          },
          "expiration": {
            "type": "object",
            "properties": {
              "ttl": {
                "type": "integer"
              }
            }
          },
          "conversionTracking": {
            "description": "Conversion tracking settings for this workspace.\nOnly present when `include=conversionTracking` is requested on the list endpoint.\n",
            "$ref": "#/components/schemas/ConversionTrackingSettings"
          }
        }
      },
      "ConversionTrackingSettings": {
        "type": "object",
        "required": [
          "enabled"
        ],
        "properties": {
          "enabled": {
            "type": "boolean",
            "description": "Whether conversion tracking is enabled for this workspace",
            "example": true
          },
          "attributionWindow": {
            "type": "integer",
            "nullable": true,
            "minimum": 1,
            "maximum": 90,
            "description": "Attribution window in days. `null` when conversion tracking is not configured\nor disabled. Defaults to 30 when enabled without specifying a value.\n",
            "example": 30
          },
          "apiKeyCreatedByOwner": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether the workspace Owner has created a conversion tracking API key. API keys are account-level resources always created by the account they belong to, so existence implies the Owner created it. The key value itself is never exposed.\n\nOn the dedicated `/workspaces/{workspace_id}/conversion-tracking` endpoint\nthis is always a boolean (the endpoint is restricted to owner/admin).\nOn the workspaces list (`include=conversionTracking`) it is a boolean for\nworkspaces where the caller has the `owner` or `admin` role, and `null`\nfor lower roles (the field is always present).\n",
            "example": true
          }
        }
      },
      "Domain": {
        "type": "object",
        "required": [
          "id",
          "fullName"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Domain public ID"
          },
          "fullName": {
            "type": "string",
            "description": "Full domain name",
            "example": "rebrand.ly"
          },
          "topLevelDomain": {
            "type": "string",
            "description": "TLD",
            "example": "ly"
          },
          "type": {
            "type": "string",
            "enum": [
              "USER",
              "SYSTEM"
            ]
          },
          "status": {
            "type": "object",
            "properties": {
              "dns": {
                "type": "string",
                "enum": [
                  "verified",
                  "unverified",
                  "verifying"
                ]
              },
              "subscription": {
                "type": "string",
                "enum": [
                  "active",
                  "inactive",
                  "pending"
                ]
              }
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "Feature": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Feature code (e.g., 'links.tags')"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "config": {
            "type": "object"
          }
        }
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "x-readme": {}
}
````