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

    Introduction

    About REST API#

    The REST API provides an interface to access your manaable data without using the manaable UI. By utilizing this REST API, you can integrate manaable into your applications however you like. All you need to do is find the target information (i.e., resource) within this documentation, choose the operation you want to perform (search, create, update, etc.), and send an HTTP request to the manaable endpoint.

    URIs#

    The URI is the path that identifies a resource in manaable. The basic structure of the URI is as follows (with exceptions):
    https://[my-domain-name].manaable.com/api/v[X]/[resource]/
    Replace [my-domain-name] with the subdomain of your manaable UI.
    Replace [X] with the version of the API you want to use.
    Replace [resource] with the resource name and the rest of the path.

    HTTP Methods#

    The REST API supports all standard HTTP request methods (GET, POST, PATCH, PUT, and DELETE). However, please note that not all resources necessarily support all methods.

    HTTP Headers#

    api-key - This provides the API key that you can obtain from the manaable Admin site to authenticate your requests.
    Modified at 2024-06-06 14:54:14
    Next
    イントロダクション
    Built with