Get access profile by ID

Returns the profile plus its role attachments and the count of users holding a copy.

GET /api/access-profiles/{id}

Error

A valid request URL is required to generate request examples

200

{
  "access_profile": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "is_active": true,
    "version": 123,
    "tags": [
      "<string>"
    ],
    "provider_configs": [
      {
        "provider_name": "<string>",
        "id": 123,
        "all_models_allowed": true,
        "allowed_models": [
          "<string>"
        ],
        "budgets": [
          {
            "max_limit": 123,
            "id": "<string>",
            "scope": "<string>",
            "current_usage": 123,
            "last_reset": "2023-11-07T05:31:56Z"
          }
        ],
        "rate_limit": {
          "id": "<string>",
          "token_max_limit": 123,
          "request_max_limit": 123,
          "token_current_usage": 123,
          "request_current_usage": 123
        }
      }
    ],
    "budgets": [
      {
        "max_limit": 123,
        "id": "<string>",
        "scope": "<string>",
        "current_usage": 123,
        "last_reset": "2023-11-07T05:31:56Z"
      }
    ],
    "rate_limit": {
      "id": "<string>",
      "token_max_limit": 123,
      "request_max_limit": 123,
      "token_current_usage": 123,
      "request_current_usage": 123
    },
    "calendar_aligned": true,
    "mcp_tool_groups": [
      {
        "tool_group_id": 123
      }
    ],
    "mcp_servers": [
      {
        "mcp_server_id": "<string>"
      }
    ],
    "mcp_tool_overrides": [
      {
        "mcp_client_id": "<string>",
        "tool_name": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "roles": [
    {
      "id": 123,
      "access_profile_id": 123,
      "role_id": 123,
      "role_name": "<string>",
      "is_default": true
    }
  ],
  "user_count": 123
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Path Parameters

id · integer · required

Response

200

application/json

Successful response

Returned by GET /api/access-profiles/{id}. Includes role attachments and the count of users holding a copy.

access_profile · object

Show child attributes

roles · object[]

Show child attributes

user_count · integer