Discover Workspace Access Requests

Discover the acting user’s access to features, integrations, models, tools, authentication methods, and member credit limits. Returns an empty list while requests are disabled. Requires access to the workspace; external collaborators use their workspace grant. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

GET/api/v2/workspaces/{workspaceId}/access-requests/discovery

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

workspaceId*string

Workspace in which the acting user requests access.

Length1 <= length <= 128

Query Parameters

search?string

Case-insensitive substring match against the access item label.

Length1 <= length <= 200
targetKind?string

Category of access to discover.

Value in"feature" | "integration" | "provider" | "model" | "tool" | "knowledge_connector" | "file_share_auth" | "chat_deploy_auth" | "usage_limit"
state?string

Filter by the acting user’s current access. Requestable items can be submitted for review.

Value in"allowed" | "requestable" | "unavailable"
sortBy?string

Field used to sort the result.

Default"label"
Value in"label"
sortOrder?string

Sort direction.

Default"asc"
Value in"asc" | "desc"
limit?integer

Maximum access items to return per page. Must be a whole number from 1 to 100. Defaults to 50.

Default50
Range1 <= value <= 100
cursor?string

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/workspaces/string/access-requests/discovery" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "target": {
        "kind": "feature",
        "configKey": "hideTablesTab"
      },
      "label": "Tables",
      "state": "requestable",
      "reason": null,
      "pendingRequestId": null
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "The request conflicts with the current state of the resource"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
GETDiscover Organization Access RequestsGETGet Organization Access Request Settings