Skip to Content
APIリファレンスウェイトリスト

ウェイトリスト

プロジェクトのローンチ前ウェイトリストを管理します。プロジェクトでウェイトリスト機能が有効になっている必要があります。

GET/v1/waitlist/signups

ParameterTypeDescription
searchstringメールの部分文字列で絞り込みます。
statusstringステータスで絞り込み:waiting、invited、joined。
limitintegerページサイズ。既定は 25。
offsetintegerスキップする件数。既定は 0。

POST/v1/waitlist/signups

ParameterTypeDescription
emailrequiredstring参加する人のメールアドレス。
referral_codestring別エントリーの共有リンク(`?ref=`)の紹介コード。

GET/v1/waitlist/signups/:id

PATCH/v1/waitlist/signups/:id

ParameterTypeDescription
statusrequiredstring新しいステータス:waiting、invited、joined。invited は invited_at を、joined は joined_at を記録します。

DELETE/v1/waitlist/signups/:id

登録の作成には有料プランの書き込みアクセスが必要です。API はメールを送信しません。返される token でポータルの順位リンク(/waitlist/status?token=...)を、referral_code で共有リンクを組み立ててください。

登録の一覧取得

curl "https://api.supdesk.app/v1/waitlist/signups?status=waiting&limit=10" \ -H "Authorization: Bearer sd_live_..."
{ "data": [ { "id": "8f7a...", "email": "jamie@example.com", "status": "waiting", "position": 42, "referral_count": 3, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": null, "joined_at": null } ], "pagination": { "limit": 25, "offset": 0, "has_more": false } }

順位は待機中のエントリーに対してリアルタイムで計算されます。invitedjoined のエントリーの順位は null です。

登録の作成

curl -X POST https://api.supdesk.app/v1/waitlist/signups \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "email": "jamie@example.com" }'
{ "data": { "id": "8f7a...", "email": "jamie@example.com", "status": "waiting", "position": 42, "referral_count": 0, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": null, "joined_at": null } }

登録の取得

curl "https://api.supdesk.app/v1/waitlist/signups/8f7a..." \ -H "Authorization: Bearer sd_live_..."
{ "data": { "id": "8f7a...", "email": "jamie@example.com", "status": "waiting", "position": 42, "referral_count": 3, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": null, "joined_at": null } }

単一の登録を返します。ID が不明な場合は 404 を返します。

登録の更新

curl -X PATCH https://api.supdesk.app/v1/waitlist/signups/8f7a... \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "status": "invited" }'
{ "data": { "id": "8f7a...", "email": "jamie@example.com", "status": "invited", "position": null, "referral_count": 3, "referral_code": "a1b2c3", "token": "9d8c7b...", "source": "api", "created_at": "2026-07-01T09:12:00Z", "invited_at": "2026-07-02T10:00:00Z", "joined_at": null } }

変更できるのは status のみです。invited への変更は invited_at を、joined への変更は joined_at を記録します。有料プランの書き込みアクセスが必要です。

登録の削除

curl -X DELETE https://api.supdesk.app/v1/waitlist/signups/8f7a... \ -H "Authorization: Bearer sd_live_..."

登録を完全に削除し 204 を返します。同じメールで再登録できます。

Last updated on