コンテンツにスキップ

メンバー API

これらのエンドポイントには can_view_members 権限が必要です。権限がないと 403 が返ります。

GET /members
クエリ型意味
page数値読むページ。1 から始まります。初期値は 1 です。
pageSize数値1 ページのメンバー数。1 から 100。初期値は 20 です。
search文字列名前とメールアドレスに一致します。
Terminal window
curl "https://api.crewcade.com/api/v1/members?page=1&pageSize=20&search=alex" \
-H "Authorization: Bearer cck_your_key_here"
{
"data": [
{
"id": "mem_123",
"status": "active",
"joinedAt": "2026-01-15T09:00:00.000Z",
"name": { "en": "Alex Kim", "ja": "アレックス・キム" },
"email": "[email protected]",
"slug": "alex-kim",
"avatarUrl": null,
"bio": { "en": "Runs every Saturday." },
"location": "Tokyo",
"socialLinks": [{ "platform": "linkedin", "url": "https://example.com/alex" }],
"roles": [{ "id": "role_123", "slug": "coach", "name": { "en": "Coach" } }],
"properties": [
{
"propertyId": "prop_123",
"propertyName": { "en": "T-shirt size", "ja": "Tシャツのサイズ" },
"type": "choice",
"optionIds": ["opt_m"],
"optionNames": [{ "en": "M" }],
"value": null,
"isSensitive": false
}
]
}
],
"pagination": { "page": 1, "pageSize": 20, "total": 1, "hasNext": false }
}

pagination で現在位置がわかります。total は一致したメンバーの数です。hasNext が true のときは、次の page を読みます。

GET /members/{memberId}

パスにメンバーの id を入れます。返事は 1 人分のメンバーで、上の data の中身と同じ形です。

そのメンバーがクラブにいない場合は 404 が返ります。

フィールド意味
idクラブ内のメンバー ID。
statusメンバーの状態。例: active。
joinedAt参加した日時。
name名前。言語コードごと。null の場合があります。
emailメールアドレス。null の場合があります。
slugプロフィールのスラッグ。null の場合があります。
avatarUrl写真の URL。null の場合があります。
bio自己紹介。言語コードごと。null の場合があります。
location場所。null の場合があります。
socialLinksplatform と url の一覧。
rolesid、slug、name の一覧。
propertiesクラブがメンバーに聞く項目への回答。下で説明します。

properties には、クラブが 設定 > カスタム項目 で用意した項目への、各メンバーの回答が入ります。

項目意味
propertyId項目の ID。
propertyName項目の名前(言語コードごと)。
type項目の種類。choice、short_text、number、date、phone、address など。
optionIdschoice 項目で選ばれた選択肢の ID。ほかの種類では空です。
optionNameschoice 項目で選ばれた選択肢の名前。同じ順番です。
valueほかの種類の回答。テキスト、数値、true/false、または住所や氏名のオブジェクト。
isSensitiveクラブがこの項目を機微な項目にしている場合は true。

メンバーが空欄のままにした項目は、一覧に入りません。

緊急連絡先のような機微な項目の回答は、キーに can_view_sensitive_member_data がある場合だけ返ります。その回答を含む返事は、すべて Crewcade に記録されます。この権限がない場合、その項目は含まれません。