manaable REST API
What's manaableAbout Us
What's manaableAbout Us
    • Introduction
    • イントロダクション
    • API v3
      • Members
        • Get Members
        • Get Member by ID
      • Teams
        • Get Teams
        • Get Team by ID
    • API v2
      • Trainings
        • List trainings / 研修一覧取得
        • Count trainings / 研修件数取得
        • Get training custom field definitions / 研修カスタムフィールド定義取得
        • Get training by ID / 研修詳細取得
        • Update training / 研修情報更新
        • Delete training / 研修削除
      • Applicants
        • List applicants / 申込者一覧取得
        • Bulk create/update applicants (upsert) / 申込者一括作成/更新 (upsert)
        • Count applicants / 申込者件数取得
        • Bulk update applicant status / 申込ステータス一括更新
      • Members
        • List members / メンバー一覧取得
        • Bulk create/update members / メンバー一括作成/更新
        • Get member custom field definitions / メンバーカスタムフィールド定義取得
        • Get member by ID / メンバー詳細取得
        • Update member / メンバー情報更新
        • Delete member / メンバー削除
        • Update member password / メンバーパスワード更新
      • Teams
        • List teams / チーム一覧取得
        • Bulk create/update teams / チーム一括作成/更新
        • Get team custom field definitions / チームカスタムフィールド定義取得
        • Get team by ID / チーム詳細取得
        • Update team / チーム情報更新
        • Delete team / チーム削除
    • API v1
      • Get member groups
        GET
    • Schemas
      • Schemas
        • ContactForm
        • Exam
        • ExamResult
        • Lesson
        • LessonAttempt
        • Notification
        • Settings
        • StaticFieldsSetting
        • TeamMember
        • TrainingQuestionnaireResponse
        • TrainingQuestionnaireTemplate
        • TrainingRegTemplate
        • TrainingTaskResponse
        • TrainingTaskTemplate
        • UnsubscriptionQuestionnaire
      • Training
      • Member
      • Team
      • TrainingApplication
      • CustomFieldMaster
      • CustomFieldData
      • ErrorResponse
      • SuccessResponse
      • ValidationErrorResponse

    API v3

    Introduction はじめに#

    This documentation covers the API v3 endpoints of manaable.
    このドキュメントは、manaableのAPI v3エンドポイントをカバーします。

    Overview 概要#

    API covers resources: Members, Teams
    APIがカバーするリソース: メンバー、チーム

    Authentication 認証#

    The mode of authentication is API key.
    認証モードはAPIキーである。
    Key: api-key
    Value: API_KEY_HERE

    How to get API key APIキーの取得方法#

    i. Go to Admin screen of manaable.
    i. 管理者画面に移動する。
    ii. In the left navigation, under the 設定 option choose the 外部連携.
    ii. 左側のナビゲーションで、「設定」オプションの「外部連携」を選択する。
    image.png
    iii. Please find and take the API key from here.
    iii. こちらからAPIキーを取得してください。
    image.png

    API Custom Status Codes APIカスタムステータスコード#

    Code: 2000
    HTTP Code: 200
    Description: Successful Operation
    説明 オペレーション成功
    Code: 3000
    HTTP Code: 403
    Description: Invalid Token
    説明 無効なトークン
    Code: 4000
    HTTP Code: 500
    Description: Member Generic Error
    説明 メンバー汎用エラー
    Code: 4001
    HTTP Code: 404
    Description: Member Not Found
    説明 メンバーが見つかりません
    Code: 4004
    HTTP Code: 400
    Description: Invalid Data
    説明 無効なデータ
    Code: 5000
    HTTP Code: 500
    Description: Team Generic Error
    説明 チーム共通エラー
    Code: 5001
    HTTP Code: 404
    Description: Team Not Found
    説明 チームが見つかりません
    Modified at 2026-04-27 04:12:36
    Previous
    イントロダクション
    Next
    Get Members
    Built with