メンバー | Callabo Developers

GET/v2/workspaces/{slug}/members

Workspace Member リストの照会

ワークスペースメンバーをステータス、チーム、検索語で絞り込み、ページ単位で取得します。

パラメータ

slug必須stringpath
ワークスペーススラッグ
offsetintegerqueryデフォルト 0
最初に返却する項目の0始まりのオフセットです。
limitintegerqueryデフォルト 20
返却する項目の最大数です。
querystring | nullquery
メンバー名またはメールアドレスに適用する検索語です。
status
MemberStatus | null
query
取得するメンバーのステータスです。
team_idinteger | nullquery
指定したチームに所属するメンバーのみを取得します。

リクエスト例

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

成功レスポンス

レスポンス本文

items必須V2Member[]
ワークスペースメンバーの一覧です。
id必須integer
メンバーの識別子です。
user_id必須integer
メンバーに関連付けられたユーザーの識別子です。
workspace_id必須integer
メンバーが所属するワークスペースの識別子です。
email必須string
メンバーのメールアドレスです。
name必須string
メンバー名です。
locale必須·
UserLocale
メンバーが使用する言語です。
status必須·
"active" | "deactivated"
ワークスペースメンバーの状態です。
base_role必須·
BaseWorkspaceRole
メンバーのワークスペースにおけるデフォルトロールです。
workspace_roles必須V2WorkspaceRole[]
メンバーに割り当てられたワークスペースのカスタムロール一覧です。
workspace_permissions必須object
ワークスペースロールの組み合わせから算出された権限です。
teams必須V2MemberTeamSummary[]
メンバーが所属するチームと各チームでの役割です。
page必須V2Pagination
ワークスペースメンバー一覧のページ情報です。
offset必須integer
最初に返却する項目の0始まりのオフセットです。
limit必須integer
指定された最大項目数です。
total必須integer
条件に一致する項目の総数です。

レスポンス例

{
  "items": [
    {
      "id": 1,
      "user_id": 1,
      "workspace_id": 1,
      "email": "developer@example.com",
      "name": "Example",
      "locale": "ko",
      "status": "active",
      "base_role": "workspace_manager",
      "workspace_roles": [
        {
          "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"
            }
          ]
        }
      ],
      "workspace_permissions": {},
      "teams": [
        {
          "id": 1,
          "name": "Example",
          "base_role": "manager",
          "team_roles": [
            {
              "id": 1,
              "name": "Example",
              "is_system_role": true,
              "permissions": [
                null
              ]
            }
          ],
          "team_permissions": {}
        }
      ]
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

エラー

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

GET/v2/workspaces/{slug}/members/me

現在のワークスペースメンバー取得

現在認証されているリクエスト元のワークスペースメンバー情報とロール情報を取得します。

パラメータ

slug必須stringpath
ワークスペーススラッグ

リクエスト例

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

成功レスポンス

レスポンス本文

id必須integer
メンバーの識別子です。
user_id必須integer
メンバーに関連付けられたユーザーの識別子です。
workspace_id必須integer
メンバーが所属するワークスペースの識別子です。
email必須string
メンバーのメールアドレスです。
name必須string
メンバー名です。
locale必須·
UserLocale
メンバーが使用する言語です。
status必須·
"active" | "deactivated"
ワークスペースメンバーの状態です。
base_role必須·
BaseWorkspaceRole
メンバーのワークスペースにおけるデフォルトロールです。
workspace_roles必須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[]
ワークスペースのカスタムロールに割り当てられた権限です。
workspace_permissions必須object
ワークスペースロールの組み合わせから算出された権限です。
teams必須V2MemberTeamSummary[]
メンバーが所属するチームと各チームでの役割です。
id必須integer
チームの識別子です。
name必須string
チーム名です。
base_role必須·
BaseTeamRole
メンバーのチームにおけるデフォルトロールです。
team_roles必須V2TeamRole[]
メンバーに割り当てられたチームのカスタムロール一覧です。
team_permissions必須object
チームロールの組み合わせから算出された権限です。

レスポンス例

{
  "id": 1,
  "user_id": 1,
  "workspace_id": 1,
  "email": "developer@example.com",
  "name": "Example",
  "locale": "ko",
  "status": "active",
  "base_role": "workspace_manager",
  "workspace_roles": [
    {
      "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"
        }
      ]
    }
  ],
  "workspace_permissions": {},
  "teams": [
    {
      "id": 1,
      "name": "Example",
      "base_role": "manager",
      "team_roles": [
        {
          "id": 1,
          "name": "Example",
          "is_system_role": true,
          "permissions": [
            {
              "resource": "member_management",
              "effect": "allow"
            }
          ]
        }
      ],
      "team_permissions": {}
    }
  ]
}

エラー

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

GET/v2/workspaces/{slug}/members/{member_id}

Workspace Member 詳細検索

ワークスペースメンバーの詳細情報とロール情報を取得します。

パラメータ

member_id必須integerpath
メンバーの識別子です。
slug必須stringpath
ワークスペーススラッグ

リクエスト例

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

成功レスポンス

レスポンス本文

id必須integer
メンバーの識別子です。
user_id必須integer
メンバーに関連付けられたユーザーの識別子です。
workspace_id必須integer
メンバーが所属するワークスペースの識別子です。
email必須string
メンバーのメールアドレスです。
name必須string
メンバー名です。
locale必須·
UserLocale
メンバーが使用する言語です。
status必須·
"active" | "deactivated"
ワークスペースメンバーの状態です。
base_role必須·
BaseWorkspaceRole
メンバーのワークスペースにおけるデフォルトロールです。
workspace_roles必須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[]
ワークスペースのカスタムロールに割り当てられた権限です。
workspace_permissions必須object
ワークスペースロールの組み合わせから算出された権限です。
teams必須V2MemberTeamSummary[]
メンバーが所属するチームと各チームでの役割です。
id必須integer
チームの識別子です。
name必須string
チーム名です。
base_role必須·
BaseTeamRole
メンバーのチームにおけるデフォルトロールです。
team_roles必須V2TeamRole[]
メンバーに割り当てられたチームのカスタムロール一覧です。
team_permissions必須object
チームロールの組み合わせから算出された権限です。

レスポンス例

{
  "id": 1,
  "user_id": 1,
  "workspace_id": 1,
  "email": "developer@example.com",
  "name": "Example",
  "locale": "ko",
  "status": "active",
  "base_role": "workspace_manager",
  "workspace_roles": [
    {
      "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"
        }
      ]
    }
  ],
  "workspace_permissions": {},
  "teams": [
    {
      "id": 1,
      "name": "Example",
      "base_role": "manager",
      "team_roles": [
        {
          "id": 1,
          "name": "Example",
          "is_system_role": true,
          "permissions": [
            {
              "resource": "member_management",
              "effect": "allow"
            }
          ]
        }
      ],
      "team_permissions": {}
    }
  ]
}

エラー

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

GET/v2/workspaces/{slug}/invitations

Workspace 招待リストの検索

ワークスペース招待をステータスで絞り込み、ページ単位で取得します。

パラメータ

slug必須stringpath
ワークスペーススラッグ
offsetintegerqueryデフォルト 0
最初に返却する項目の0始まりのオフセットです。
limitintegerqueryデフォルト 20
返却する項目の最大数です。
status
WorkspaceInviteStatus | null
query
取得するワークスペース招待のステータスです。

リクエスト例

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

成功レスポンス

レスポンス本文

items必須V2Invitation[]
ワークスペース招待の一覧です。
id必須integer
ワークスペース招待IDです。
email必須string
招待先のメールアドレスです。
status必須·
WorkspaceInviteStatus
ワークスペース招待の状態です。
invited_by_member_id必須integer
招待を送信したメンバーの識別子です。
base_role必須·
BaseWorkspaceRole
招待受諾時に付与するワークスペースのデフォルトロールです。
workspace_roles必須V2WorkspaceRole[]
招待受諾時に付与するワークスペースのカスタムロール一覧です。
invited_at必須string (date-time)
ワークスペース招待の送信日時です。
accepted_atstring (date-time) | null
ワークスペース招待の受諾日時です。
cancelled_atstring (date-time) | null
ワークスペース招待の取消日時です。
created_at必須string (date-time)
ワークスペース招待の作成日時です。
updated_at必須string (date-time)
ワークスペース招待の最終更新日時です。
page必須V2Pagination
ワークスペース招待一覧のページ情報です。
offset必須integer
最初に返却する項目の0始まりのオフセットです。
limit必須integer
指定された最大項目数です。
total必須integer
条件に一致する項目の総数です。

レスポンス例

{
  "items": [
    {
      "id": 1,
      "email": "developer@example.com",
      "status": "pending",
      "invited_by_member_id": 1,
      "base_role": "workspace_manager",
      "workspace_roles": [
        {
          "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"
            }
          ]
        }
      ],
      "invited_at": "2026-08-27T03:00:00Z",
      "created_at": "2026-08-27T03:00:00Z",
      "updated_at": "2026-08-27T03:00:00Z"
    }
  ],
  "page": {
    "offset": 1,
    "limit": 1,
    "total": 1
  }
}

エラー

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

GET/v2/workspaces/{slug}/invitations/{invitation_id}

Workspaceの招待詳細の表示

ワークスペース招待の詳細情報と現在のステータスを取得します。

パラメータ

invitation_id必須integerpath
ワークスペース招待IDです。
slug必須stringpath
ワークスペーススラッグ

リクエスト例

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

成功レスポンス

レスポンス本文

id必須integer
ワークスペース招待IDです。
email必須string
招待先のメールアドレスです。
status必須·
WorkspaceInviteStatus
ワークスペース招待の状態です。
invited_by_member_id必須integer
招待を送信したメンバーの識別子です。
base_role必須·
BaseWorkspaceRole
招待受諾時に付与するワークスペースのデフォルトロールです。
workspace_roles必須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[]
ワークスペースのカスタムロールに割り当てられた権限です。
invited_at必須string (date-time)
ワークスペース招待の送信日時です。
accepted_atstring (date-time) | null
ワークスペース招待の受諾日時です。
cancelled_atstring (date-time) | null
ワークスペース招待の取消日時です。
created_at必須string (date-time)
ワークスペース招待の作成日時です。
updated_at必須string (date-time)
ワークスペース招待の最終更新日時です。

レスポンス例

{
  "id": 1,
  "email": "developer@example.com",
  "status": "pending",
  "invited_by_member_id": 1,
  "base_role": "workspace_manager",
  "workspace_roles": [
    {
      "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"
        }
      ]
    }
  ],
  "invited_at": "2026-08-27T03:00:00Z",
  "created_at": "2026-08-27T03:00:00Z",
  "updated_at": "2026-08-27T03:00:00Z"
}

エラー

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