List secrets

List workspace secrets visible to the caller and caller-owned personal secrets. Only workspace secrets marked unredacted can include values; every other entry contains metadata only. Requires workspace read access. Personal secrets belong to the caller across workspaces. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:read.

GET/api/v2/secrets

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

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

curl -X GET "https://www.sim.ai/api/v2/secrets?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "name": "STRIPE_API_KEY",
      "scope": "workspace",
      "description": "Production billing key — rotate quarterly.",
      "unredacted": false,
      "role": "admin",
      "createdAt": "2026-06-01T09:14:00.000Z",
      "updatedAt": "2026-06-20T14:02:11.000Z"
    },
    {
      "name": "STAGING_BASE_URL",
      "scope": "workspace",
      "description": "Staging environment base URL.",
      "unredacted": true,
      "role": "member",
      "createdAt": "2026-06-03T11:30:00.000Z",
      "updatedAt": "2026-06-21T08:45:09.000Z",
      "value": "https://staging.example.com"
    }
  ],
  "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"
  }
}

Query parameters

workspaceId*string

Workspace whose secret metadata should be listed.

Length1 <= length <= 128
scope?string

Restrict results to one ownership scope.

Value in"workspace" | "personal"
search?string

Case-insensitive substring match against the secret name.

Length1 <= length <= 200
sortBy?string

Field used to sort the result. Do not rely on case-insensitive ordering when sorting by name.

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

Sort direction.

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

Maximum secrets 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

DELETEDelete secretPUTSet secret