CallaboDevelopersBeta
ドキュメントメニュー

REST API

ロール

ワークスペースロールとチームロールの詳細情報と権限を取得します。

GET/v2/workspaces/{slug}/workspace-roles

Workspace role リストの照会

ワークスペースロールとロールごとのメンバー数をページ単位で取得します。

パラメータ

  • slug必須stringpath
    ワークスペーススラッグ
  • offsetintegerqueryデフォルト 0
    最初に返却する項目の0始まりのオフセットです。
  • limitintegerqueryデフォルト 100
    返却する項目の最大数です。

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/workspace-roles" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

  • items必須V2WorkspaceRole[]
    ワークスペースのカスタムロール一覧です。
  • id必須integer
    ワークスペースのカスタムロール識別子です。
  • name必須string
    ワークスペースのカスタムロール名です。
  • descriptionstring | null
    ワークスペースのカスタムロールの説明です。
  • is_system_role必須boolean
    システム管理ロールかどうかを示します。
  • member_count必須integer
    ロールが割り当てられたメンバー数です。
  • created_at必須string (date-time)
    ロールの作成日時です。
  • updated_at必須string (date-time)
    ロールの最終更新日時です。
  • permissions必須V2Permission[]
    ワークスペースのカスタムロールに割り当てられた権限です。
  • page必須V2Pagination
    ワークスペースのカスタムロール一覧のページ情報です。
  • offset必須integer
    最初に返却する項目の0始まりのオフセットです。
  • limit必須integer
    指定された最大項目数です。
  • total必須integer
    条件に一致する項目の総数です。

レスポンス例

{
  "items": [
    {
      "id": 1,
      "name": "Example",
      "is_system_role": true,
      "member_count": 1,
      "created_at": "2026-08-27T03:00:00Z",
      "updated_at": "2026-08-27T03:00:00Z",
      "permissions": [
        {
          "resource": "member_management",
          "effect": "allow"
        }
      ]
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

エラー

ステータスエラーコード説明
401UNAUTHORIZED未認証のリクエスト
403FORBIDDENリクエスト元の権限が不足しています
404WORKSPACE_NOT_FOUND存在しません
422VALIDATION_ERROR処理できないコンテンツ
429RATE_LIMIT_EXCEEDEDリクエスト上限超過詳細
GET/v2/workspaces/{slug}/workspace-roles/{role_id}

Workspace role 詳細検索

ワークスペースロールの権限と割り当て済みメンバー数を取得します。

パラメータ

  • role_id必須integerpath
    ロールIDです。
  • slug必須stringpath
    ワークスペーススラッグ

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/workspace-roles/1" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

  • id必須integer
    ワークスペースのカスタムロール識別子です。
  • name必須string
    ワークスペースのカスタムロール名です。
  • descriptionstring | null
    ワークスペースのカスタムロールの説明です。
  • is_system_role必須boolean
    システム管理ロールかどうかを示します。
  • member_count必須integer
    ロールが割り当てられたメンバー数です。
  • created_at必須string (date-time)
    ロールの作成日時です。
  • updated_at必須string (date-time)
    ロールの最終更新日時です。
  • permissions必須V2Permission[]
    ワークスペースのカスタムロールに割り当てられた権限です。
  • resource必須PermissionResource
    権限を適用するリソースです。
  • effect必須PermissionStatus
    リソースに適用する許可または拒否の状態です。

レスポンス例

{
  "id": 1,
  "name": "Example",
  "is_system_role": true,
  "member_count": 1,
  "created_at": "2026-08-27T03:00:00Z",
  "updated_at": "2026-08-27T03:00:00Z",
  "permissions": [
    {
      "resource": "member_management",
      "effect": "allow"
    }
  ]
}

エラー

ステータスエラーコード説明
401UNAUTHORIZED未認証のリクエスト
403FORBIDDENリクエスト元の権限が不足しています
404WORKSPACE_NOT_FOUND, WORKSPACE_ROLE_NOT_FOUND存在しません
422VALIDATION_ERROR処理できないコンテンツ
429RATE_LIMIT_EXCEEDEDリクエスト上限超過詳細
GET/v2/workspaces/{slug}/team-roles

Team role リストの照会

チームロールと権限をページ単位で取得します。

パラメータ

  • slug必須stringpath
    ワークスペーススラッグ
  • offsetintegerqueryデフォルト 0
    最初に返却する項目の0始まりのオフセットです。
  • limitintegerqueryデフォルト 100
    返却する項目の最大数です。

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/team-roles" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

  • items必須V2TeamRole[]
    チームのカスタムロール一覧です。
  • id必須integer
    チームのカスタムロール識別子です。
  • name必須string
    チームのカスタムロール名です。
  • descriptionstring | null
    チームのカスタムロールの説明です。
  • is_system_role必須boolean
    システム管理ロールかどうかを示します。
  • permissions必須V2Permission[]
    チームのカスタムロールに割り当てられた権限です。
  • page必須V2Pagination
    チームのカスタムロール一覧のページ情報です。
  • offset必須integer
    最初に返却する項目の0始まりのオフセットです。
  • limit必須integer
    指定された最大項目数です。
  • total必須integer
    条件に一致する項目の総数です。

レスポンス例

{
  "items": [
    {
      "id": 1,
      "name": "Example",
      "is_system_role": true,
      "permissions": [
        {
          "resource": "member_management",
          "effect": "allow"
        }
      ]
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

エラー

ステータスエラーコード説明
401UNAUTHORIZED未認証のリクエスト
403FORBIDDENリクエスト元の権限が不足しています
404WORKSPACE_NOT_FOUND存在しません
422VALIDATION_ERROR処理できないコンテンツ
429RATE_LIMIT_EXCEEDEDリクエスト上限超過詳細
GET/v2/workspaces/{slug}/team-roles/{role_id}

Team role 詳細検索

チームロールの詳細情報と権限を取得します。

パラメータ

  • role_id必須integerpath
    ロールIDです。
  • slug必須stringpath
    ワークスペーススラッグ

リクエスト例

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/team-roles/1" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

成功レスポンス

レスポンス本文

  • id必須integer
    チームのカスタムロール識別子です。
  • name必須string
    チームのカスタムロール名です。
  • descriptionstring | null
    チームのカスタムロールの説明です。
  • is_system_role必須boolean
    システム管理ロールかどうかを示します。
  • permissions必須V2Permission[]
    チームのカスタムロールに割り当てられた権限です。
  • resource必須PermissionResource
    権限を適用するリソースです。
  • effect必須PermissionStatus
    リソースに適用する許可または拒否の状態です。

レスポンス例

{
  "id": 1,
  "name": "Example",
  "is_system_role": true,
  "permissions": [
    {
      "resource": "member_management",
      "effect": "allow"
    }
  ]
}

エラー

ステータスエラーコード説明
401UNAUTHORIZED未認証のリクエスト
403FORBIDDENリクエスト元の権限が不足しています
404WORKSPACE_NOT_FOUND, TEAM_ROLE_NOT_FOUND存在しません
422VALIDATION_ERROR処理できないコンテンツ
429RATE_LIMIT_EXCEEDEDリクエスト上限超過詳細
© 2026 Return Zero, Inc.