コンテンツにスキップ

イベント API

APIキーでイベントを読むには、can_view_all_events 権限が必要です。参加者の一覧には can_check_in_attendees も必要です。権限がないと 403 が返ります。

Crewcade でサインインで得たメンバートークンでも、イベントを読めます。追加のスコープは不要です。メンバーには、クラブのページがそのメンバーに見せる内容が表示されます。参加者の一覧は APIキー専用です。

API は日程(occurrence)を返します。日程とは、イベントの 1 回分のことです。

  • 1 回だけのイベントには日程が 1 つあります。その id はイベントの publicId です。
  • 繰り返しイベントには日程がたくさんあります。日程ごとに 8 文字の id があります。すべての日程は同じ seriesId(シリーズの publicId)を持ちます。

id は変わりません。クラブが「この日程以降」を編集しても、同じ日程は同じ id のままです。

下書きは表示されません。中止された日程は status: "cancelled" で表示されます。

GET /events
クエリ型意味
fromstring期間の始まり。Z かオフセット付きの ISO-8601 時刻。初期値は現在。
tostring期間の終わり。形式は同じ。初期値は from の 30 日後。最長 92 日。
seriesIdstringこの繰り返しイベントの日程だけを返します。
pagenumber読むページ。1 から始まります。初期値は 1。
pageSizenumber1 ページの日程数。1 から 100。初期値は 20。

日程は早い順に返ります。

  • これからの日程と開催中の日程は、from を空にします。
  • 過去の日程は、to を現在にし、from をそれより前にします。
Terminal window
curl "https://api.crewcade.com/api/v1/events?from=2026-11-01T00:00:00%2B09:00" \
-H "Authorization: Bearer cck_your_key_here"

返事の形は英語版の例と同じです。

期間が逆、92 日より長い、またはタイムゾーンがない場合は 400 が返ります。

GET /events/{id}

日程の id を渡します。返事はイベント 1 件で、一覧の data の項目と同じ形です。

繰り返しシリーズの publicId を渡すと、code: "event_is_series" 付きの 404 が返ります。日程は GET /events?seriesId={id} で一覧できます。

GET /events/{id}/registrations

can_view_all_events と can_check_in_attendees が必要です。クラブがイベントの参加者ページで見るものと同じ一覧を返します。その日程の確定した登録と当日参加の人です。

クエリ型意味
pagenumber読むページ。1 から始まります。初期値は 1。
pageSizenumber1 ページの人数。1 から 100。初期値は 20。

status は going、checked_in、no_show のどれかです。当日参加の人やメンバーでないゲストは memberId が null です。

項目意味
id日程の id。ほかの呼び出しにはこれを使います。
seriesId繰り返しシリーズの publicId。1 回だけのイベントは null。
publicIdイベントの publicId。繰り返しの日程ではシリーズのものです。
slug読みやすいラベル。変わることがあります。
urlKeyCrewcade のイベントリンクで使う slug-publicId の形のキー。
titleタイトル。言語コードごと。
description説明。言語コードごと。null のこともあります。
start, endその日のオフセット付きの dateTime と、IANA の timeZone。
timingupcoming、live、past。呼び出したときに決まります。
statusscheduled か cancelled。
locationTypein_person、online、hybrid、none。
venuename と address。どちらも null のことがあります。
hostNameその日の主催者。言語コードごと。null のこともあります。
coverImageUrlフライヤー画像。null のこともあります。
capacity定員。null は上限なし。
spotsRemaining残りの席。null は上限なし。
propertiesクラブがイベント用に決めた項目(クラブ名やレベルなど)。
eventUrlCrewcade のイベントページのアドレス。一覧にも 1 つの日程にもあります。
tiersその日程のチケット。1 つの日程だけにあります。下を見てください。

GET /events/{id} は tiers を返します。ティアは、チケットの 1 つの種類です。

フィールド意味
idティアの id。メンバーを申し込ませるとき tierId として送ります。
name名前(言語コードごと)。nameText は、求めた言語の 1 つのテキストです。
description短い説明。null のこともあります。
priceamount(通貨の最小単位)と currency。0 は無料です。
payMethodscard または in_person。無料のティアでは空です。
saleStart、saleEnd販売が始まる時刻と終わる時刻。null のこともあります。
soldOutこの日程でこのティアの席がなくなると true です。
forYouサインインしたメンバーにとってのこのティアの状態。APIキーでは null です。

saleStart と saleEnd は、UTC の ISO 8601 形式の時刻です。Crewcade は、ティアに設定した時刻を、イベントのタイムゾーンで計算します。

forYou には 3 つのフィールドがあります。

  • available は、メンバーがいまこのティアを選べると true です。
  • reason は、ティアが閉じている理由です。tier_disabled、role_restricted、event_full、sold_out のどれかです。開いている有料ティアでは payment_required です。開いている無料ティアでは null です。
  • registerVia は、1 回の呼び出しで申し込ませられるときは api です。メンバーを eventUrl に送るときは event_page です。申し込みを見てください。