List Permission Groups

List permission groups in an organization with cursor pagination. Requires organization admin or owner access and active Access Control. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

GET/api/v2/organizations/{organizationId}/permission-groups

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 permission groups.

Length1 <= length

Query Parameters

search?string

Case-insensitive substring match against the group name.

Length1 <= length <= 200
sortBy?string

Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order.

Default"createdAt"
Value in"name" | "createdAt" | "updatedAt"
sortOrder?string

Sort direction.

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

Maximum permission groups 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

curl -X GET "https://www.sim.ai/api/v2/organizations/string/permission-groups" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "group-123",
      "organizationId": "org-123",
      "name": "Restricted",
      "description": null,
      "config": {
        "allowedIntegrations": null,
        "allowedModelProviders": null,
        "deniedModels": [],
        "deniedTools": [],
        "hideTraceSpans": false,
        "hideKnowledgeBaseTab": false,
        "hideTablesTab": false,
        "hideCopilot": false,
        "hideIntegrationsTab": false,
        "hideSecretsTab": false,
        "hideApiKeysTab": false,
        "hideInboxTab": false,
        "hideFilesTab": false,
        "disableMcpTools": false,
        "disableCustomTools": false,
        "disableSkills": false,
        "disableInvitations": false,
        "disablePublicApi": false,
        "disablePublicFileSharing": false,
        "allowedFileShareAuthTypes": null,
        "hideDeployApi": false,
        "hideDeployMcp": false,
        "hideDeployChatbot": false,
        "allowedChatDeployAuthTypes": null,
        "disablePersonalApiKeys": false,
        "disableLogExport": false,
        "hideCostInfo": false,
        "disableKnowledgeBaseCreation": false,
        "disableKnowledgeBaseFileUpload": false,
        "allowedKnowledgeConnectors": null,
        "disableTableCreation": false,
        "disableTableExport": false,
        "disableBulkFileDownload": false,
        "disablePersonalCredentials": false,
        "disableWorkspaceCreation": false,
        "hideOrgMemberDirectory": false,
        "disableCliAccess": false,
        "disableWebhookTriggers": false,
        "disableToolAutoApproval": false,
        "hideSandboxesTab": false,
        "disableOAuthAppAccess": false,
        "disableKnowledgeBaseExport": false
      },
      "isDefault": false,
      "membershipMode": "inherit",
      "workspaceIds": [
        "workspace-123"
      ],
      "createdBy": "admin-123",
      "createdAt": "2026-06-01T09:00:00.000Z",
      "updatedAt": "2026-06-01T09:00:00.000Z"
    }
  ],
  "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": "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 Permission Group MembersDELETERemove Permission Group Member