manaable REST API
What's manaableAbout Us
What's manaableAbout Us
  1. Members
  • Introduction
  • イントロダクション
  • API v3
    • Members
      • Get Members
        GET
      • Get Member by ID
        GET
    • 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
  1. Members

Get Members

GET
/api/v3/members/

Request

Authorization
Add parameter in header
api-key
Example:
api-key: ********************
Query Params

Responses

🟢200Success
application/json
Bodyapplication/json

🟢200Success (Without Pagination)
🟠400Bad Request
🟠403Forbidden
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v3/members/?pagination=undefined&per_page=undefined&page=undefined&keyword=undefined&limit=undefined&created_from=undefined&created_to=undefined&updated_from=undefined&updated_to=undefined&order=undefined&fields=undefined&includes=undefined' \
--header 'api-key: <api-key>'
Response Response Example
200 - Example 1
{
    "code": "2000",
    "message": "Success",
    "data": {
        "current_page": 1,
        "first_page_url": "{BASE_URL}/api/v3/members?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "{BASE_URL}/api/v3/members?page=10",
        "links": [
            {
                "url": "{url}/api/v3/members?page=1",
                "label": "1",
                "active": true
            }
        ],
        "next_page_url": "{BASE_URL}/api/v3/members?page=2",
        "path": "{BASE_URL}/api/v3/members",
        "per_page": 10,
        "prev_page_url": null,
        "to": 10,
        "total": 100,
        "members": [
            {
                "id": 0,
                "updated_at": "2019-08-24T14:15:22.123Z",
                "created_at": "2019-08-24T14:15:22.123Z",
                "email": "user@example.com",
                "first_name": "string",
                "last_name": "string",
                "kana_first_name": "string",
                "kana_last_name": "string",
                "gender": "string",
                "d_o_b": "2019-08-24",
                "postal_code": "string",
                "street_address": "string",
                "phone_number": "string",
                "prefecture": "string",
                "municipality": "string",
                "town": "string",
                "building": "string",
                "admission_status": "string",
                "is_active": "ACTIVE",
                "ext_id": "string",
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "organisation": "string",
                "deleted_at": "2019-08-24T14:15:22.123Z",
                "formatted_id": "string"
            }
        ]
    }
}
Modified at 2024-06-04 12:15:34
Previous
API v3
Next
Get Member by ID
Built with