Preview Organization Access Request

Preview the current permission changes, affected group and audience, or member credit cap. Review canApply, changes, impact, and fingerprint before resolving. Permission changes affect the entire governing group, not only the requester. Requires organization administrator access. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

GET/api/v2/organizations/{organizationId}/access-requests/{requestId}/preview

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

organizationId*string

Organization that owns the access requests.

Length1 <= length
requestId*string

Access request identifier.

Length1 <= length <= 128

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/organizations/string/access-requests/string/preview" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "resolutionKind": "permission",
    "request": {
      "id": "request-123",
      "organizationId": "org-123",
      "workspaceId": "workspace-123",
      "target": {
        "kind": "feature",
        "configKey": "hideTablesTab"
      },
      "targetLabel": "Tables",
      "reason": "Maintain team data",
      "status": "pending",
      "decisionReason": null,
      "createdAt": "2026-06-01T09:00:00.000Z",
      "decidedAt": null,
      "groupName": "Engineering",
      "requester": {
        "id": "user-123",
        "name": "Alex Example",
        "email": "alex@example.com"
      }
    },
    "group": {
      "id": "group-123",
      "name": "Engineering"
    },
    "changes": [
      {
        "configKey": "hideTablesTab",
        "label": "Tables",
        "before": true,
        "after": false
      }
    ],
    "impact": {
      "memberCount": 2,
      "workspaceCount": 1,
      "workspaceNames": [
        "Engineering"
      ],
      "truncated": false
    },
    "fingerprint": "current-preview-fingerprint",
    "canApply": true,
    "unavailableReason": null,
    "currentLimitCredits": null,
    "newLimitCredits": 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"
  }
}
GETList Organization Access RequestsPOSTResolve Organization Access Request