スキーマ
API のリクエスト・レスポンスに現れるオブジェクトの型をまとめています。各エンドポイントのページの「型」欄は、ここの定義へリンクしています。
共通
PageInfo
| フィールド | 型 | 説明 |
|---|---|---|
totalCount | number | 条件に一致する総件数。 |
totalPages | number | 総ページ数。 |
page | number | 現在のページ番号(1 始まり)。 |
perPage | number | 1 ページあたりの件数。 |
{ "totalCount": 100, "totalPages": 5, "page": 1, "perPage": 20 }Languages
| フィールド | 型 | 説明 |
|---|---|---|
<lang>.title | string任意 | その言語で表示するタイトル。 |
<lang>.name | string任意 | その言語で表示する名称。 |
<lang>.description | string任意 | その言語で表示する説明。 |
<lang>.label | string任意 | その言語で表示するラベル。 |
<lang>.bio | string任意 | その言語で表示する自己紹介。 |
<lang>.url | string任意 | その言語で開く URL。 |
<lang>.displayText | string任意 | その言語で表示する場所のテキスト。 |
どのキーを持つかは対象のデータによる(イベント・セッションは title / description、コミュニティ・チケット・ステージ・ミーティング場所は name / description、連絡先は label、選択肢は title、カスタムナビゲーションは title / url、登壇者は title / bio、場所は displayText)。指定した言語のみ上書きされ、未指定の言語は既定のフィールドが使われる。
{
"ja": { "title": "オープニング基調講演", "description": "..." },
"en": { "title": "Opening Keynote", "description": "..." }
}Contact
| フィールド | 型 | 説明 |
|---|---|---|
label | string | null任意 | 表示ラベル(例: お問い合わせ窓口)。 |
email | string | null任意 | メールアドレス。 |
url | string | null任意 | 問い合わせフォームなどの URL。 |
x / instagram / facebook / youtube | string | null任意 | 公式 SNS。 |
languages | Languages | null任意 | 言語別のラベル。 |
オブジェクトの配列(最大 10 件)で指定する。後方互換のため単一オブジェクトも受け付ける。
[
{
"label": "お問い合わせ",
"email": "contact@example.com",
"languages": { "en": { "label": "Contact" } }
}
]Location
| フィールド | 型 | 説明 |
|---|---|---|
placeId | string任意 | Google Places の場所 ID。 |
displayText | string任意 | 表示用のテキスト(例: 東京都渋谷区)。 |
name / shortName | string任意 | 場所名・略称。 |
title | string任意 | 会場の表示ラベル。 |
country / countryCode | string任意 | 国名と国コード(JP など)。 |
state / locality / city | string任意 | 都道府県・州、地域、市区町村。 |
zipCode / address / building | string任意 | 郵便番号・住所・建物名。 |
geo | GeoPoint | null任意 | 座標。 |
googleMapsURI | string任意 | Google マップの URL。 |
websiteUrl / tel | string任意 | 会場のウェブサイト・電話番号。 |
description | string任意 | 会場の補足説明。 |
primary | boolean任意 | 複数会場のうち主要な会場か。 |
languages | Languages | null任意 | 言語別の表示テキスト。 |
ユーザーの居住地では name / shortName / locality / googleMapsURI を、イベント・ミーティングの会場では title / websiteUrl / tel / description / primary を使う。
更新するときは placeId / countryCode / displayText / name / locality / city / state / country のいずれかを 1 つ以上含める必要がある。null または空文字でクリアできる。
イベントの会場は、単一のオブジェクトまたは複数会場を表すオブジェクトの配列を指定できる。
{
"placeId": "ChIJ...",
"displayText": "東京都渋谷区",
"countryCode": "JP",
"state": "東京都",
"city": "渋谷区",
"geo": { "lat": 35.6595, "lng": 139.7005 }
}GeoPoint
| フィールド | 型 | 説明 |
|---|---|---|
lat | number必須 | 緯度。 |
lng | number必須 | 経度。 |
{ "lat": 35.6595, "lng": 139.7005 }GeoGeometry
| フィールド | 型 | 説明 |
|---|---|---|
type | 'Point' | 'MultiPoint' | ジオメトリの種別。 |
coordinates | number[] | number[][] | 座標。Point は [lng, lat]、MultiPoint はその配列。 |
{ "type": "Point", "coordinates": [139.7671, 35.6812] }GeoFeature
| フィールド | 型 | 説明 |
|---|---|---|
type | 'Feature' | GeoJSON の Feature。 |
geometry | GeoGeometry | 座標。複数会場のイベントは MultiPoint。 |
properties | GeoFeatureProperties | ピンに紐づく項目の情報。 |
{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [139.7671, 35.6812] },
"properties": { "eventId": "e1f2a3b4-...", "slug": "tech-conf-2026", "title": "4S Tech Conference 2026" }
}GeoFeatureProperties
| フィールド | 型 | 説明 |
|---|---|---|
eventId | string | イベント ID。 |
slug | string | イベントページの識別子。 |
title | string | イベント名。 |
languages | Languages | null | 言語別のイベント名。イベントの地図のみ。 |
playlistItemId | string | プレイリスト項目 ID。プレイリストの地図のみ。 |
kind | 'FOUR_S_EVENT' | 'EXTERNAL_LINK' | 項目の種別。プレイリストの地図のみ。 |
CustomStyle
| フィールド | 型 | 説明 |
|---|---|---|
theme | 'light' | 'dark'任意 | ベースのテーマ。 |
primaryColor | string任意 | アクセント色(CSS の色表記)。 |
primaryButtonLabelColor | string任意 | 主要ボタンの文字色。 |
backgroundColor | string任意 | 背景色。 |
titleTextColor | string任意 | 見出しの文字色。 |
textColor / textSubColor | string任意 | 本文・補助テキストの文字色。 |
{
"theme": "dark",
"primaryColor": "#4f7cff",
"backgroundColor": "#101114"
}ユーザー・組織
User
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ユーザー ID。 |
slug | string | プロフィール URL に使う識別子。 |
guest | boolean | ゲストユーザー(運営が代理登録した登壇者・参加者)か。 |
firstName / lastName | string | null | 名・姓。 |
nativeName | string | null | 母語表記の氏名。 |
avatarUrl | string | null | アバター画像の URL。 |
title | string | null | 肩書き。 |
bio | string | null | 自己紹介。 |
languages | string[] | 話せる言語のコード。 |
lang | string | null | 既定の表示言語。 |
tags | string[] | タグ(スキルなど)。一覧・検索系の API で付く。 |
location | Location | null | 所在地。プロフィール詳細で返る。 |
socialLinks | SocialLinks | null | SNS リンク。プロフィール詳細で返る。 |
organizationMembers | OrganizationMember[] | 所属(職歴・学歴)。プロフィール詳細で返る。 |
cardDesign | string | null | 名刺カードのデザイン。背景画像の ID か、自分の写真を使う "custom"。未設定は null。プロフィール詳細で返る。 |
cardPhoto | CardPhoto | null | 名刺カードに使う自分の写真と見せ方。プロフィール詳細で返る。他人の分は、名刺カードに使っている(cardDesign が "custom")ときだけ返る。 |
email | string | メールアドレス。自分自身の情報(GET /users/me)のみ。OAuth アクセストークン経由では返さない。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
退会済みユーザーは、表示名・アバターをマスクした状態で返る(チャットのメッセージなど、行を残す必要がある箇所のみ)。
SocialLinks
| フィールド | 型 | 説明 |
|---|---|---|
x / twitter | string任意 | X(旧 Twitter) |
instagram / facebook / youtube | string任意 | Instagram / Facebook / YouTube。 |
linkedin / github | string任意 | LinkedIn / GitHub。 |
whatsapp | string任意 | WhatsApp。 |
website | string任意 | 個人サイトなどの URL。 |
UnreadByCategory
| フィールド | 型 | 説明 |
|---|---|---|
chat | number | 通常のチャットの未読メッセージ数。 |
event | number | イベントチャットの未読メッセージ数。 |
community | number | コミュニティチャットの未読メッセージ数。 |
{ "chat": 5, "event": 4, "community": 3 }Organization
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 組織 ID。 |
slug | string | 組織ページの識別子。 |
name | string | 組織名。 |
type | string | COMPANY / STARTUP / SCHOOL / GOVERNMENT / NON_PROFIT / RESEARCH / VENTURE_CAPITAL / MEDIA / ACCELERATOR / EDUCATIONAL / CONSULTING / COMMUNITY のいずれか。 |
description | string | null | 説明。 |
websiteUrl | string | null | ウェブサイトの URL。 |
logoUrl / logoDarkUrl | string | null | ロゴ画像(ダークテーマ用を含む)の URL。 |
memberCount | number | 在籍中のメンバー数。 |
createdBy | User | 作成者。詳細取得で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
OrganizationMember
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 所属 ID。 |
organizationId | string | 組織 ID。 |
userId | string | ユーザー ID。 |
role | 'ADMIN' | 'MEMBER' | 組織内のロール。 |
title | string | null | 役職・肩書き。 |
startDate / endDate | string | null | 在籍期間(YYYY-MM-DD)。endDate が null なら在籍中。 |
current | boolean | 現在も在籍しているか。 |
user | User | 対象ユーザー。組織のメンバー一覧で返る。 |
organization | Organization | 所属先の組織。ユーザーの所属一覧で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
コミュニティ
Community
| フィールド | 型 | 説明 |
|---|---|---|
id | string | コミュニティ ID。 |
slug | string | コミュニティページの識別子。 |
name | string | コミュニティ名。 |
description | string | null | 説明。 |
languages | Languages | null | 言語別の name / description。 |
joinType | 'FREE_JOIN' | 'APPROVAL_REQUIRED' | 'INVITATION_ONLY' | 参加方法。 |
visibility | 'PUBLIC' | 'LIMITED' | 'PRIVATE' | 公開範囲。 |
logoUrl / logoDarkUrl | string | null | ロゴ画像(ダークテーマ用を含む)の URL。 |
featured | boolean | 運営によるピックアップ。 |
enabledChat | boolean | コミュニティチャットが有効か。 |
cardDesign | string | null | コミュニティの名刺カードのデザイン。背景画像の ID か、写真を使う "custom"。未設定は null。 |
cardPhoto | CardPhoto | null | コミュニティの名刺カードに使う写真と見せ方。名刺カードに使っている(cardDesign が "custom")ときだけ返る。管理用の API(/manage/communities)では、別のデザインに替えている間も返る。 |
memberCount | number | メンバー数。 |
tags | string[] | タグ。 |
contact | Contact[] | 連絡先。詳細取得で返る。 |
createdBy | User | 作成者。詳細取得で返る。 |
membershipRole / membershipTitle | string | null | 閲覧対象ユーザーの参加ロール・肩書き。ユーザーの参加コミュニティ一覧で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
CommunityMember
| フィールド | 型 | 説明 |
|---|---|---|
id | string | メンバー ID。 |
communityId | string | コミュニティ ID。 |
userId | string | ユーザー ID。 |
role | 'ADMIN' | 'MEMBER' | コミュニティ内のロール。 |
status | 'PENDING' | 'APPROVED' | 'REJECTED' | 参加状態。 |
title | string | null | コミュニティ内の肩書き。 |
approvedAt | string | null | 承認日時。 |
user | User | 対象ユーザー。 |
community | Community | コミュニティ。ユーザー起点の API で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
CommunityMemberCounts
| フィールド | 型 | 説明 |
|---|---|---|
total | number | メンバーの総数。 |
byRole | Record<string, number> | ロード(ADMIN / MEMBER)ごとの件数。 |
byStatus | Record<string, number> | 参加状態(APPROVED / PENDING / REJECTED)ごとの件数。 |
{
"total": 120,
"byRole": { "ADMIN": 2, "MEMBER": 118 },
"byStatus": { "APPROVED": 118, "PENDING": 2 }
}イベント
Event
| フィールド | 型 | 説明 |
|---|---|---|
id | string | イベント ID。 |
slug | string | イベントページの識別子。 |
title | string | イベント名。 |
catchphrase | string | null | キャッチコピー。 |
description | string | null | 説明(Markdown)。 |
languages | Languages | null | 言語別の title / description。 |
eventType | 'ONSITE' | 'ONLINE' | 'HYBRID' | 開催形式。 |
state | 'DRAFT' | 'PUBLISHED' | 'PRIVATE' | 'CANCELED' | 公開状態。 |
timezone | string | タイムゾーン(例: Asia/Tokyo)。schedules の時刻はこのタイムゾーンで解釈する。 |
schedules | EventSchedule[] | 開催日ごとの日程。 |
location | Location | Location[] | null | 会場。複数会場のときは配列。 |
onlineUrl / onlineDescription | string | null | オンライン会場の URL と案内。参加者向けの専用 API のみで返る。 |
thumbnailUrl / mainImageUrl | string | null | サムネイル・メイン画像の URL。 |
organizers | EventOrganizer[] | 主催者(コミュニティまたはユーザー)。 |
tickets | Ticket[] | チケット種別。含める API のみ。 |
tags | string[] | タグ。 |
isPaid | boolean | 有料チケット(price > 0)があるか。 |
hasEnded | boolean | 終了済みか。公開 API と、ミーティングに含まれるイベントで返る。 |
hasInvitationTickets | boolean | 招待用チケットがあるか。 |
requiresApproval | boolean | 参加登録に承認が必要か。 |
registrationPaused | boolean | 参加登録を一時停止しているか。 |
maxParticipants | number | null | 定員。 |
participantListVisibility | 'PUBLIC' | 'PARTICIPANTS_ONLY' | 'PRIVATE' | 参加者一覧の公開範囲。 |
enabledTickets / enabledMeetings / enabledChat / enabledSideEvents / enabledReferralTree / enabledConferenceMode | boolean | 各機能の有効・無効。 |
featured | boolean | 運営によるピックアップ。 |
createdBy | User | 作成者。詳細取得で返る。 |
staffRole | 'ADMIN' | 'EDITOR' | 'COORDINATOR' | 'RECEPTIONIST' | 自分のスタッフロール。管理イベント一覧で返る。 |
participantCount | number | 参加者数(CONFIRMED + CHECKED_IN)。管理イベント一覧で返る。 |
entryState / checkedInAt / entryCreatedAt / entryCount / ticket | mixed | 自分(または対象ユーザー)の参加登録の状態・チェックイン時刻・登録日時・枚数・チケット。参加イベント一覧で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
EventSchedule
| フィールド | 型 | 説明 |
|---|---|---|
date | string必須 | 開催日(YYYY-MM-DD)。 |
doorTime | string | null任意 | 開場時刻(HH:mm)。 |
startTime | string必須 | 開始時刻(HH:mm)。 |
endTime | string必須 | 終了時刻(HH:mm)。 |
[
{ "date": "2026-09-01", "doorTime": "09:30", "startTime": "10:00", "endTime": "18:00" }
]EventOrganizer
EventDateGroup
| フィールド | 型 | 説明 |
|---|---|---|
date | string | 開催日(YYYY-MM-DD)。 |
events | Event[] | その日に開催されるイベント。 |
EventStaff
| フィールド | 型 | 説明 |
|---|---|---|
id | string | スタッフ ID。 |
eventId | string | イベント ID。 |
userId | string | ユーザー ID。 |
role | 'ADMIN' | 'EDITOR' | 'COORDINATOR' | 'RECEPTIONIST' | スタッフロール。 |
user | User | 対象ユーザー。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
StaffPermissionsByRole
| フィールド | 型 | 説明 |
|---|---|---|
ADMIN | string[] | ADMIN が持つ権限 ID。 |
EDITOR | string[] | EDITOR が持つ権限 ID。 |
COORDINATOR | string[] | COORDINATOR が持つ権限 ID。 |
RECEPTIONIST | string[] | RECEPTIONIST が持つ権限 ID。 |
参加登録
EventEntry
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 参加登録 ID。 |
eventId | string | イベント ID。 |
userId | string | 参加者のユーザー ID。 |
state | 'UNUSED' | 'PENDING' | 'AWAITING_PAYMENT' | 'CONFIRMED' | 'REJECTED' | 'CHECKED_IN' | 'CANCELED' | 参加状態。 |
ticketId | string | null | チケット種別 ID。 |
ticket | Ticket | null | チケット種別。含める API のみ。 |
user | User | 参加者。含める API のみ。 |
speaker | Speaker | null | 登壇者メタデータ。登壇者でない参加登録では null。 |
checkedInAt | string | null | チェックイン日時。 |
checkInToken | string | チェックイン用トークン(QR に埋め込む)。管理 API のみ。 |
acceptsMeetingRequests | boolean | ミーティングリクエストを受け付けるか。 |
invitedByEntryId | string | null | 招待元の参加登録 ID。 |
invitationGeneration | number | null | 招待の世代(招待元から何段目か)。 |
invitationRootEntryId | string | null | 招待チェーンの起点の参加登録 ID。 |
canCreateInvitationCode | boolean | この参加登録から招待コードを作れるか。 |
paymentSubtotal / paymentTotal / paymentRefunded | number | null | 決済の小計・合計・返金済み金額。 |
cancellationReason | string | null | キャンセル理由。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
Participant
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 参加登録 ID。 |
eventId | string | イベント ID。 |
userId | string | 参加者のユーザー ID。 |
state | 'CONFIRMED' | 'CHECKED_IN' | 参加状態(確定済みの参加者のみが一覧に出る)。 |
acceptsMeetingRequests | boolean | ミーティングリクエストを受け付けるか。 |
user | User | 参加者の公開プロフィール。 |
ticketId | string | null | チケット種別 ID。 |
ticket | Ticket | null | チケット種別。 |
invitedByEntryId | string | null | 招待元の参加登録 ID。 |
_count | ParticipantCounts | この参加者に紐づく集計。 |
ParticipantCounts
| フィールド | 型 | 説明 |
|---|---|---|
invitedEntries | number | この参加者が招待した人数。 |
{ "invitedEntries": 3 }ParticipantDemographic
| フィールド | 型 | 説明 |
|---|---|---|
key | string | 属性の値(性別・年代・都道府県・国)。 |
count | number | 件数。 |
{ "key": "male", "count": 120 }EntryProfileFields
| フィールド | 型 | 説明 |
|---|---|---|
avatarUrl / nativeName / birthDate / gender / location / title / bio | 'off' | 'optional' | 'required'任意 | その項目を出さない / 任意 / 必須。キーが無い場合は off と同じ。 |
{
"nativeName": "required",
"gender": "optional",
"location": "optional"
}EntryProfileAnswers
| フィールド | 型 | 説明 |
|---|---|---|
avatarUrl | string | null任意 | アバター画像の URL。 |
nativeName | string | null任意 | 母語表記の氏名。 |
lang | string | null任意 | 母語の言語コード。nativeName とセットで登録する。 |
birthDate | string | null任意 | 生年月日(YYYY-MM-DD)。 |
gender | 'male' | 'female' | 'other' | 'undisclosed' | null任意 | 性別。 |
location | Location | null任意 | 居住地。 |
title | string | null任意 | 肩書き。 |
bio | string | null任意 | 自己紹介。 |
収集する項目はイベントの entryProfileFields で決まる。null を送るとその項目をクリアする。
EntryActivityLog
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ログ ID。 |
type | 'ENTRY_CREATED' | 'STATE_CHANGED' | 'PAYMENT_COMPLETED' | 'CHECKOUT_ENTRIES_CREATED' | 'REFUND_INITIATED' | 'REFUND_COMPLETED' | 'TICKET_CHANGED' | 'HOLDER_TRANSFERRED' | 'USER_CANCELED' | 操作の種類。 |
source | 'STAFF_MANAGE' | 'STAFF_ADMIN' | 'USER' | 'STRIPE_WEBHOOK' | 'SYSTEM' | 操作の経路。 |
payload | Record<string, unknown> | 操作の内容(状態変更の from / to など、種類ごとに異なる)。 |
actorUserId | string | null | 操作したユーザーの ID。システム操作では null。 |
actor | User | null | 操作したユーザー。 |
createdAt | string | 操作日時(ISO 8601)。 |
{
"id": "al1a2b3-...",
"type": "STATE_CHANGED",
"source": "STAFF_MANAGE",
"payload": { "from": "UNUSED", "to": "CHECKED_IN" },
"actorUserId": "a1b2c3d4-...",
"actor": { "id": "a1b2c3d4-...", "slug": "taro", "firstName": "太郎", "lastName": "山田" },
"createdAt": "2026-09-01T01:05:00.000Z"
}InviterOption
ReferralEntry
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 参加登録 ID。 |
invitedByEntryId | string | null | 招待元の参加登録 ID。 |
invitationGeneration | number | null | 招待の世代(起点が 0)。 |
invitationRootEntryId | string | null | 招待チェーンの起点となる参加登録 ID。 |
user | User | null | 参加者。無効な state の祖先では null。 |
ticketName | string | null | チケット名。 |
invitedEntriesCount | number | このノードが直接招待した人数。 |
disabled | boolean | 無効な state で内容を伏せている場合に true。祖先の取得のみ。 |
children | ReferralEntry[] | 直接の子ノード(childrenLimit 件まで)。子孫の取得のみ。 |
childrenTotalCount | number | 直接の子の総数。子孫の取得のみ。 |
childrenNextCursor | string | null | 子の続きを取得するカーソル。無ければ null。子孫の取得のみ。 |
祖先の取得では disabled / user: null がありうる(無効な state の親)。子孫の取得では children に同じ形のノードが再帰的に入る。
ReferralRankingItem
| フィールド | 型 | 説明 |
|---|---|---|
rank | number | 順位(1 始まり)。 |
rankingType | 'SCORE' | 'DESCENDANT_COUNT' | ランキング種別。 |
score | number | ランキングのスコア。 |
entryId | string | 参加登録 ID。 |
user | User | 招待者。 |
ticketName | string | null | チケット名。 |
directInviteCount | number | 直接招待した人数。 |
indirectInviteCount | number | 間接的に招待した人数。 |
descendantCount | number | 招待チェーンの子孫の総数。 |
maxDescendantGeneration | number | 子孫の最大世代数。 |
checkedInInviteCount | number | 招待した人のうちチェックイン済みの人数。 |
チケット
Ticket
| フィールド | 型 | 説明 |
|---|---|---|
id | string | チケット種別 ID。 |
eventId | string | イベント ID。 |
name | string | チケット名。 |
description | string | null | 説明。 |
languages | Languages | null | 言語別の name / description。 |
price | number | 価格(日本円)。 |
paymentType | 'FREE' | 'ONSITE_PAYMENT' | 'PREPAID_STRIPE' | 支払い方法。 |
salesLimit | number | null | 販売上限数。null は無制限。 |
status | 'DRAFT' | 'PUBLISHED' | 'PRIVATE' | 公開状態。 |
confirmUserBasicInfo | boolean | 購入時に基本情報の確認を求めるか。 |
requiresApproval | boolean | 参加に主催者の承認が必要か。 |
transferable | boolean | 譲渡できるか。 |
displayOrder | number | 表示順。 |
isLowStock / isSoldOut | boolean | 残りわずか・売り切れ。salesLimit が設定されている場合のみ。 |
prepaidStripePurchaseAvailable / prepaidStripePurchaseBlockedReason | mixed | 事前決済が購入可能か、不可の場合の理由(NO_STRIPE_PRICE / STRIPE_CONNECT_NOT_CONFIGURED)。 |
invitationEnabled / invitationTargetTicketId / invitationMaxGenerations / invitationLimit / invitationDiscountEnabled / invitationDiscountPercent / invitationDiscountAmount | mixed | 招待機能の設定。管理 API のみ。 |
uniqueId | string | チケットの一意な公開 ID。管理 API のみ。 |
_count | TicketCounts | 販売数の集計。管理 API のみ。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
TicketCounts
| フィールド | 型 | 説明 |
|---|---|---|
entries | number | そのチケットでの参加登録数。 |
unusedEntries | number | 未使用(未チェックイン)の参加登録数。 |
{ "entries": 120, "unusedEntries": 45 }TicketEntryCount
| フィールド | 型 | 説明 |
|---|---|---|
ticketId | string | チケット種別 ID。 |
name | string | チケット名。 |
count | number | そのチケットでの参加登録数。 |
{ "ticketId": "t1a2b3c4-...", "name": "一般チケット", "count": 300 }StripeRefund
| フィールド | 型 | 説明 |
|---|---|---|
id | string | Stripe の返金 ID。 |
amount | number | 返金額(日本円)。 |
status | string | Stripe 上の状態(succeeded / pending / failed など)。 |
{ "id": "re_1A2B3C...", "amount": 5000, "status": "succeeded" }プログラム・登壇者
Stage
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ステージ ID。 |
eventId | string | イベント ID。 |
name | string | ステージ名。 |
description | string | null | 説明。 |
languages | Languages | null | 言語別の name / description。 |
capacity | number | null | 収容人数。 |
order | number | 表示順。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
Session
| フィールド | 型 | 説明 |
|---|---|---|
id | string | セッション ID。 |
eventId | string | イベント ID。 |
stageId | string | null | ステージ ID。 |
stage | Stage | null | ステージ。含める API のみ。 |
title | string | セッション名。 |
description | string | null | 説明。 |
languages | Languages | null | 言語別の title / description。 |
startTime / endTime | string | null | 開始・終了日時(ISO 8601)。 |
status | 'DRAFT' | 'COMPLETED' | 'CANCELLED' | 公開状態。公開 API では返さない(公開済みのセッションのみ返す)。 |
sessionSpeakers | SessionSpeaker[] | 登壇者の紐づけ。含める API のみ。 |
event | Event | 開催イベントの概要。ユーザーの登壇セッション一覧で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
SessionSpeaker
| フィールド | 型 | 説明 |
|---|---|---|
id | stringレスポンスのみ | 紐づけ ID。 |
sessionId | stringレスポンスのみ | セッション ID。 |
entryId | string必須 | 登壇者の参加登録 ID。 |
order | number任意 | セッション内の表示順。 |
status | 'DRAFT' | 'PENDING' | 'CONFIRMED' | 'REJECTED'任意 | 登壇の確定状態。公開 API では CONFIRMED のみ返る。 |
role | string | null任意 | セッション内での役割(モデレーターなど)。 |
comment | string | null任意 | 運営用のメモ。管理 API のみ。 |
speaker | Speaker | nullレスポンスのみ | 登壇者。 |
createdAt | stringレスポンスのみ | 作成日時(ISO 8601) |
updatedAt | stringレスポンスのみ | 更新日時(ISO 8601) |
Speaker
| フィールド | 型 | 説明 |
|---|---|---|
id / entryId | string | 参加登録 ID(同じ値)。 |
eventId | string | イベント ID。 |
userId | string | ユーザー ID。 |
firstName / lastName / nativeName / avatarUrl / title / bio | string | null | 表示用の氏名・アバター・肩書き・自己紹介。登壇者側の上書き値が無ければユーザーの値を返す。 |
languages | Languages | null | 言語別の表示項目。 |
pickedUp | boolean | 注目登壇者としてピックアップするか。 |
displayOrder | number | 表示順。 |
user | User | ユーザー。 |
sessions | Session[] | 登壇セッション。詳細取得で返る(確定 + 公開済みのみ)。 |
overrides | SpeakerOverrides | 登壇者側で上書きした値。管理 API のみ。 |
entry | EventEntry | 参加登録の状態。id / state / ticketId / checkedInAt / ticket のみを含む。管理 API のみ。 |
surveyToken | string | null | 登壇者アンケート用トークン。管理 API のみ。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
SpeakerOverrides
| フィールド | 型 | 説明 |
|---|---|---|
firstName / lastName / nativeName | string | null任意 | 表示名の上書き。 |
avatarUrl | string | null任意 | アバター画像の上書き。 |
title | string | null任意 | 肩書きの上書き。 |
bio | string | null任意 | 自己紹介の上書き。 |
languages | Languages | null任意 | 言語別の肩書き・自己紹介。 |
null はユーザー情報を使い、空文字を含む文字列はその値で上書きする(空文字 = 登壇者としては空)。更新時に指定しなかった項目は変更されない。
{
"firstName": null,
"lastName": null,
"nativeName": null,
"avatarUrl": null,
"title": "Principal Engineer",
"bio": null,
"languages": null
}GuestProfile
| フィールド | 型 | 説明 |
|---|---|---|
firstName / lastName / nativeName | string | null任意 | 氏名。 |
email | string | null任意 | メールアドレス。 |
lang | string | null任意 | 母語の言語コード。 |
avatarUrl | string | null任意 | アバター画像の URL。null を送るとアバターを消す。 |
title | string | null任意 | 肩書き。 |
bio | string | null任意 | 自己紹介。 |
アンケート
Question
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 設問 ID。 |
refId | string | null | 他の設問を参照する場合の参照先 ID(回答を共有する)。 |
eventId / sessionId | string | null | 紐づくイベント・セッション。 |
type | 'text' | 'longText' | 'email' | 'url' | 'singleSelect' | 'multiSelect' | 'toggle' | 'radioButton' | 'date' | 'image' | 設問タイプ。 |
title | string | 設問文。 |
description | string | null | 補足説明。 |
languages | Languages | null | 言語別の title / description。 |
options | QuestionOption[] | 選択肢。選択式の設問のみ。 |
required | boolean | 回答が必須か。 |
ticketIds | string[] | 対象のチケット種別 ID。空配列は全チケット対象。 |
order | number | 表示順。 |
status | 'DRAFT' | 'PUBLISHED' | 公開状態。公開 API では PUBLISHED のみ返る。 |
searchable | boolean | 参加者検索・公開プロフィールでこの設問の回答を見せるか。 |
settings | QuestionSettings | null | 設問タイプ別の設定。 |
branchParentId / conditionOptionIds | mixed | 条件分岐。親設問の指定した選択肢が選ばれたときのみ表示する。 |
showOnDashboard | boolean | 管理ダッシュボードに集計グラフを出すか。管理 API のみ。 |
answer | QuestionAnswer | null | 対象ユーザーの回答。回答付きで返す API のみ。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
公開の設問一覧(GET /events/:eventId/questions)は id / type / title / description / languages / options / required / order / settings のみを返す。
QuestionOption
| フィールド | 型 | 説明 |
|---|---|---|
id | string任意 | 選択肢 ID。既存の選択肢を更新するときに指定する。省略すると保存時に採番される。 |
title | string必須 | 選択肢のラベル。 |
languages | Languages | null任意 | 言語別のラベル({ [lang]: { title } })。 |
deleted | boolean任意 | 削除済みか。true を送ると選択肢を削除する。 |
options | QuestionOption[]任意 | 入れ子の選択肢。条件分岐で使う。 |
選択肢の表示順は options 配列の順番で決まる。
回答(QuestionAnswer.answer)や集計(QuestionAggregationOption.value)では、選択肢を id で参照する。集計のレスポンスだけは title を label という名前で返す。
[
{ "id": "a1b2c3d4-...", "title": "SNS", "languages": { "en": { "title": "Social media" } } },
{ "title": "知人の紹介" }
]QuestionAnswer
| フィールド | 型 | 説明 |
|---|---|---|
id | stringレスポンスのみ | 回答 ID。 |
questionId | string必須 | 設問 ID。 |
userId | stringレスポンスのみ | 回答したユーザーの ID。 |
answer | string[]必須 | 回答値。選択式は選択肢 ID、画像は画像 URL が入る。 |
user | Userレスポンスのみ | 回答したユーザー。管理 API のみ。 |
createdAt | stringレスポンスのみ | 作成日時(ISO 8601) |
updatedAt | stringレスポンスのみ | 更新日時(ISO 8601) |
参加登録・回答更新のリクエストで送るのは questionId と answer だけ。answer は 1 要素以上の文字列配列で、各要素 1000 文字以内。
QuestionSettings
| フィールド | 型 | 説明 |
|---|---|---|
width | number任意 | 画像の幅(px)。16〜4096 の整数。image タイプのみ。 |
height | number任意 | 画像の高さ(px)。16〜4096 の整数。image タイプのみ。 |
{ "width": 1200, "height": 630 }QuestionAggregation
| フィールド | 型 | 説明 |
|---|---|---|
questionId | string | 設問 ID。 |
questionTitle | string | 設問文。 |
questionLanguages | Languages | null | 言語別の設問文。 |
type | string | 設問タイプ。 |
options | QuestionAggregationOption[] | 選択肢ごとの件数。 |
showOnDashboard | boolean | ダッシュボードに表示する設問か。ダッシュボード集計のみ。 |
QuestionAggregationOption
| フィールド | 型 | 説明 |
|---|---|---|
value | string | 選択肢 ID。 |
label | string | 選択肢のラベル。 |
count | number | その選択肢を選んだ人数。 |
languages | Languages | null | 言語別のラベル。 |
{ "value": "o1", "label": "SNS", "count": 120 }SurveyResponse
| フィールド | 型 | 説明 |
|---|---|---|
userId | string | 回答者のユーザー ID。 |
entryId | string | 参加登録 ID。 |
entryType | 'USER' | 'SPEAKER' | 参加者か登壇者か。 |
displayName | string | 一覧に表示する氏名。 |
state | string | 参加状態。 |
ticketName | string | チケット名。 |
isPrepaidPayment | boolean | 事前決済か。 |
paymentTotal / paymentRefunded | number | 支払い済み額・返金済み額。 |
user | User | null | 回答者。 |
speaker | Speaker | null | 登壇者メタデータ。登壇者のみ。 |
profileAnswers | EntryProfileAnswers | null | 参加登録時に回答したプロフィール項目。 |
answers | Record<string, string[]> | 設問 ID をキーにした回答値。 |
updatedAt / entryCreatedAt | string | 回答の最終更新日時・参加登録日時(ISO 8601)。 |
お知らせ
Announcement
| フィールド | 型 | 説明 |
|---|---|---|
id | string | お知らせ ID。 |
eventId / communityId | string | null | 紐づくイベント・コミュニティ(どちらか一方)。 |
title | string | 件名。 |
content | string | 本文。 |
targetStates | string[] | 配信対象の参加状態(イベントお知らせのみ)。 |
targetTicketIds | string[] | 配信対象のチケット種別 ID。空配列は全チケット対象(イベントお知らせのみ)。 |
sendEmail | boolean | メールを送るか。false ならアプリ内通知と掲載のみ。 |
deliveryStatus | 'PENDING' | 'PROCESSING' | 'SENT' | 'FAILED' | 'SKIPPED' | 配信状況。管理 API のみ。 |
deliveredAt | string | null | 配信完了日時。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
ミーティング
Meeting
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ミーティング ID。 |
eventId | string | イベント ID。 |
chatRoomId | string | 調整に使うチャットルーム ID。 |
fromUserId | string | リクエストしたユーザーの ID。 |
toUserId | string | リクエストされたユーザーの ID。 |
status | 'REQUESTED' | 'CONFIRMED' | 'CANCELED' | 'REJECTED' | ミーティングの状態。 |
spotId | string | null | 確定したミーティング場所の ID。 |
startAt / endAt | string | null | 確定した開始・終了日時(ISO 8601)。 |
tableOrder | number | null | 場所内のテーブル番号。 |
canceledBy / rejectedBy | string | null | キャンセル・拒否したユーザーの ID。 |
event / chatRoom / fromUser / toUser / spot | mixed | 関連するイベント・チャットルーム・相手・場所。含める API のみ。event はタイトル・slug・日程(schedules)・hasEnded など、ミーティングの表示に使う項目だけを含む。fromUser / toUser は表示用の項目だけで、メールアドレスなどは含まない。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
MeetingSpot
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 場所 ID。 |
eventId | string | イベント ID。 |
name | string | 場所名。 |
description | string | null | 説明。 |
languages | Languages | null | 言語別の name / description。 |
capacity | number | 同時に実施できるミーティング数。 |
active | boolean | 利用可能か。 |
imageUrl | string | null | 場所の画像 URL。 |
location | Location | null | 場所の位置情報。 |
tableLimit | number | null | テーブル数の上限。 |
ticketIds | string[] | 利用できるチケット種別 ID。空配列は全チケット対象。 |
availableTimes | Record<string, [string, string]> | null | 日付(YYYY-MM-DD)をキーにした [開始時刻, 終了時刻](HH:mm)。 |
blockedTimes | Record<string, [string, string]> | null | 日付(YYYY-MM-DD)をキーにした [開始時刻, 終了時刻](HH:mm)。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
MeetingTimeSlot
| フィールド | 型 | 説明 |
|---|---|---|
spotId | string | 場所 ID。 |
spotName | string | 場所名。 |
startAt / endAt | string | 枠の開始・終了日時(ISO 8601)。 |
available | boolean | 空いているか。 |
{
"spotId": "ms1a2b3c-...",
"spotName": "Meeting Table A",
"startAt": "2026-06-01T05:00:00.000Z",
"endAt": "2026-06-01T05:30:00.000Z",
"available": true
}MeetingRequestQuota
| フィールド | 型 | 説明 |
|---|---|---|
limit | number | 作成できるリクエストの上限。 |
used | number | 作成済みの件数。 |
remaining | number | 残り作成できる件数。 |
{ "limit": 50, "used": 3, "remaining": 47 }Schedule
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 予定 ID。 |
userId | string | ユーザー ID。 |
eventId | string | null | 紐づくイベント ID。 |
startAt / endAt | string | 開始・終了日時(ISO 8601)。 |
description | string | null | 予定の内容。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
プレイリスト
Playlist
| フィールド | 型 | 説明 |
|---|---|---|
id | string | プレイリスト ID。 |
communityId | string | null | 作成したコミュニティの ID。 |
name | string | プレイリスト名。 |
description | string | null | 説明。 |
languages | Languages | null | 言語別の name / description。 |
thumbnailImageUrl | string | null | サムネイル画像の URL。 |
sortOrder | number | 表示順。 |
sticky | boolean | 一覧の先頭に固定するか。 |
featured | boolean | 運営によるピックアップ。 |
submissionEnabled | boolean | 一般ユーザーからの追加申請を受け付けるか。 |
submissionMessage | string | null | 追加申請時に表示する運営からのメッセージ。 |
itemCount | number | 公開中のアイテム数。 |
pendingCount | number | 承認待ちのアイテム数。管理 API のみ。 |
community | Community | コミュニティ。id / name / slug のみを含む。含める API のみ。 |
items | PlaylistItem[] | アイテム。含める API のみ。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
PlaylistItem
| フィールド | 型 | 説明 |
|---|---|---|
id | string | アイテム ID。 |
playlistId | string | プレイリスト ID。 |
sortOrder | number | 表示順。 |
kind | 'FOUR_S_EVENT' | 'EXTERNAL_LINK' | アイテムの種類。 |
status | 'PUBLISHED' | 'PENDING' | 'REJECTED' | 公開状態。PENDING は追加申請中。 |
eventId | string | null | 4S イベントの ID(kind = FOUR_S_EVENT)。 |
sourceUrl | string | null | 外部イベントの URL(kind = EXTERNAL_LINK)。 |
title | string | 表示名。4S イベントではイベント名で上書きされる。 |
description | string | null | 説明。 |
imageUrl | string | null | 画像の URL。 |
schedules | EventSchedule[] | null | 開催日程。4S イベントではイベント側の値。 |
location | Location | Location[] | null | 会場。4S イベントではイベント側の値。 |
organizerName / organizerNames | string | null | 主催者名(外部イベントは入力値、4S イベントは主催者名の連結)。 |
startTime / endTime / eventStartTime | string | null | 開始・終了日時(ISO 8601)。upcoming / past の絞り込みに使う。 |
eventSlug / eventThumbnailUrl / eventMainImageUrl / eventTags | mixed | 4S イベントの識別子・画像・タグ。 |
requestedById / requestedByName / reviewedAt | mixed | 追加申請したユーザーと審査日時。管理 API のみ。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
PlaylistItemStatusCounts
| フィールド | 型 | 説明 |
|---|---|---|
PUBLISHED | number | 公開中の件数。 |
PENDING | number | 承認待ちの件数。 |
REJECTED | number | 却下された件数。 |
{ "PUBLISHED": 12, "PENDING": 2, "REJECTED": 1 }PlaylistCollectionProperties
| フィールド | 型 | 説明 |
|---|---|---|
playlistId | string | プレイリスト ID。 |
playlistName | string | プレイリスト名。 |
{ "playlistId": "pl1-...", "playlistName": "おすすめイベント" }ExternalEventPreview
| フィールド | 型 | 説明 |
|---|---|---|
canonicalUrl | string | 正規化した URL。プレイリストに登録するときはこれを使う。 |
title | string | null | ページのタイトル。 |
description | string | null | ページの説明。 |
imageUrl | string | null | OGP 画像の URL。 |
schedules | EventSchedule[] | ページから読み取れた開催日程。取得できなければ空配列。 |
チャット
ChatRoom
| フィールド | 型 | 説明 |
|---|---|---|
id | string | チャットルーム ID。 |
type | 'DIRECT' | 'GROUP' | ルームの種類。 |
name | string | null | ルーム名。DIRECT では null。 |
status | 'ACTIVE' | 'ARCHIVED' | ルームの状態。 |
communityId / eventId | string | null | 紐づくコミュニティ・イベント。 |
community / event | Community | Event | null | 紐づくコミュニティ・イベント。名前・画像など一部のフィールドのみを含む。 |
createdById | string | 作成者のユーザー ID。 |
createdBy | User | 作成者。詳細取得で返る。 |
members | ChatRoomMember[] | メンバー。 |
lastMessage | Message | null | 最新のメッセージ(システムメッセージを除く)。一覧で返る。 |
unreadCount | number | 自分の未読件数。一覧で返る。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
ChatRoomMember
| フィールド | 型 | 説明 |
|---|---|---|
id | string | メンバー ID。 |
roomId | string | チャットルーム ID。 |
userId | string | ユーザー ID。 |
status | 'INVITED' | 'JOINED' | 'LEFT' | 参加状態。 |
lastReadAt | string | null | 最後に既読にした日時。 |
joinedAt / leftAt | string | null | 参加・退出日時。 |
notificationsEnabled | boolean | このルームの通知が ON か。 |
user | User | 対象ユーザー。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
Message
| フィールド | 型 | 説明 |
|---|---|---|
id | string | メッセージ ID。 |
roomId | string | チャットルーム ID。 |
type | 'USER' | 'SYSTEM' | メッセージの種類。SYSTEM は参加・退出などの通知。 |
senderId | string | 送信者のユーザー ID。 |
sender | User | 送信者。退会済みの場合はマスクされる。 |
content | string | 本文。 |
imageUrl | string | null | 画像メッセージの URL。 |
fileId / fileName / fileSize / fileMimeType / fileDeleted / fileFolderName | mixed | 添付ファイルの情報。添付があるメッセージのみ。 |
replyToId | string | null | 返信元のメッセージ ID。 |
replyTo | MessageReplyTo | null | 返信元の概要。 |
reactions | MessageReaction[] | リアクション。取得していない経路ではフィールド自体を返さない。 |
deletedAt | string | null | 削除日時。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
MessageReaction
| フィールド | 型 | 説明 |
|---|---|---|
emoji | string | 絵文字。 |
count | number | 押した人数(userIds が打ち切られていても総数)。 |
userIds | string[] | 押したユーザーの ID(先頭 100 件まで)。 |
users | User[] | 押したユーザー(押された順)。 |
メッセージ一覧とリアクションの追加・削除では userIds を返す。誰が押したかを表示するときは GET /chat-rooms/:roomId/messages/:messageId/reactions を使う(こちらは users を返す)。
{ "emoji": "👍", "count": 2, "userIds": ["a1b2c3d4-...", "b2c3d4e5-..."] }MessageReplyTo
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 返信元のメッセージ ID。 |
deleted | boolean | 返信元が削除済みか。true のときは本文・送信者を返さない。 |
senderId | string | null | 送信者のユーザー ID。 |
sender | User | 送信者。退会済みの場合はマスクされる。 |
content | string | 本文。 |
imageUrl | string | null | 画像メッセージの URL。 |
fileName | string | 添付ファイル名。添付があるメッセージのみ(URL は含まない)。 |
Mention
| フィールド | 型 | 説明 |
|---|---|---|
userId | string必須 | メンションする相手のユーザー ID。 |
name | string必須 | 本文中の `@name` と一致する表示名。 |
[{ "userId": "a1b2c3d4-...", "name": "山田太郎" }]ChatImage
| フィールド | 型 | 説明 |
|---|---|---|
messageId | string | 画像を含むメッセージの ID。 |
senderId | string | 送信者のユーザー ID。 |
imageUrl | string | 画像の URL。 |
createdAt | string | 送信日時(ISO 8601)。 |
ChatFolder
| フィールド | 型 | 説明 |
|---|---|---|
id | string | フォルダ ID。 |
name | string | フォルダ名。 |
表示中のフォルダ(folder)とパンくず(breadcrumbs)で使う。一覧の行としてのフォルダは ChatLibraryItem を参照。
{ "id": "fd1a2b3c-...", "name": "議事録" }ChatLibraryItem
| フィールド | 型 | 説明 |
|---|---|---|
type | 'folder' | 'file' | 行の種別。 |
id | string | フォルダ ID またはファイル ID。 |
name | string | 表示名。 |
parentId | string | null | 親フォルダ ID。type が folder のときのみ。 |
folderId | string | null | 所属フォルダ ID。type が file のときのみ。 |
mimeType | string | MIME タイプ。type が file のときのみ。 |
size | number | バイト数。type が file のときのみ。 |
messageId | string | null | ファイルを添付したメッセージの ID。type が file のときのみ。 |
createdAt | string | 作成日時(ISO 8601)。 |
名刺交換・ミートログ
CardExchange
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 交換 ID。 |
status | 'SCANNED' | 'PENDING' | 'ACCEPTING' | 'ACCEPTED' | 'EXPIRED' | SCANNED = スキャンした、PENDING = 申し込んだ、ACCEPTING = 承認処理中、ACCEPTED = 成立、EXPIRED = 期限切れ。 |
role | 'REQUESTER' | 'TARGET' | 閲覧者の立場(申し込んだ側 / 申し込まれた側)。 |
counterpart | CardExchangeUser | 相手の要約。相手がコミュニティとして交換しているときは、交換を担当している管理者。 |
counterpartCommunity | CardExchangeCommunity | null | 相手がコミュニティとして交換しているときの、そのコミュニティ。個人としての交換では null。 |
myCommunity | CardExchangeCommunity | null | 閲覧者がコミュニティとして交換しているときの、そのコミュニティ。個人としての交換では null。 |
expiresAt | string | 交換中は申し込み・承認の期限、成立後は結果を読める期限(ISO 8601)。 |
createdAt | string | スキャンした日時。 |
requestedAt | string | null | 申し込んだ日時。 |
respondedAt | string | null | 成立した日時。 |
myShareEmail | boolean | null | 閲覧者がこの交換で選んだメールアドレスの開示。まだ選んでいなければ null。 |
defaultShareEmail | boolean | チェックボックスの初期値(閲覧者が操作する番のときだけ。前回の開示設定、なければ true)。閲覧者がコミュニティとして交換するときは返さない。 |
mySubscribeNewsletter | boolean | null | 閲覧者がこの交換で選んだ「メルマガを受け取る」。相手がコミュニティでない・まだ選んでいなければ null。 |
defaultSubscribeNewsletter | boolean | 「メルマガを受け取る」の初期値(閲覧者が操作する番で、相手がコミュニティのときだけ。前回の設定、なければ true)。 |
previousExchange | CardExchangeHistory | null | 前回までの交換(閲覧者が操作する番のときだけ)。コミュニティとしての交換は、個人どうしの交換とは別の相手として数える。 |
result | CardExchangeResult | null | 成立後の閲覧者側の結果。 |
CardExchangeUser
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ユーザー ID。 |
slug | string | ユーザー名(プロフィール URL)。 |
firstName | string | null | 名(英語表記)。 |
lastName | string | null | 姓(英語表記)。 |
nativeName | string | null | 母語での氏名。 |
avatarUrl | string | null | アバター画像。 |
title | string | null | 肩書き。 |
bio | string | null | 自己紹介(交換の確認画面でだけ入る。500 文字で切る)。一覧では null。 |
cardDesign | string | null | 名刺カードのデザイン。背景画像の ID か、自分の写真を使う "custom"。未設定は null。 |
cardPhoto | CardPhoto | null | 名刺カードに使っている自分の写真と見せ方(cardDesign が "custom" のときだけ)。 |
organization | CardExchangeOrganization | null | 現在の所属(学歴・終了した経歴は除く)。 |
CardExchangeCommunity
| フィールド | 型 | 説明 |
|---|---|---|
id | string | コミュニティ ID。 |
slug | string | コミュニティページの識別子。 |
name | string | コミュニティ名。 |
languages | Languages | null | 言語別のコミュニティ名(name のみ。description は含まない)。 |
logoUrl / logoDarkUrl | string | null | ロゴ画像(ダークテーマ用を含む)の URL。 |
cardDesign | string | null | コミュニティの名刺カードのデザイン。背景画像の ID か、写真を使う "custom"。未設定は null。 |
cardPhoto | CardPhoto | null | コミュニティの名刺カードに使っている写真と見せ方(cardDesign が "custom" のときだけ)。 |
コミュニティの公開範囲(visibility)に関係なく、名刺交換の相手には返します。交換中(CardExchange)の値は、スキャンした時点のものです。
cardDesign が null(未設定)のときにどのデザインで描くかは、クライアントが決めます。4S の公式アプリは、コミュニティの名刺カードをプラチナ(metal-03-platinum)で描きます(人の名刺カードの既定は solid-07-h216)。
CardPhoto
| フィールド | 型 | 説明 |
|---|---|---|
url | string | 写真の URL(POST /users/me/card-photo が返したもの。コミュニティの名刺カードでは POST /manage/communities/:id/card-photo が返したもの)。 |
brightness | number | 明度の調整。-100〜100 の整数(1% 刻み)。0 が元の写真で、正は白、負は黒のレイヤーをその濃さ(%)で重ねる。 |
textColor | "white" | "black" | 写真の上の文字色。 |
CardExchangeOrganization
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 組織 ID。 |
name | string | 組織名。 |
slug | string | 組織のスラッグ。 |
logoUrl | string | null | ロゴ。 |
title | string | null | 組織での役職。 |
CardExchangeHistory
| フィールド | 型 | 説明 |
|---|---|---|
exchangeCount | number | これまでの交換回数。 |
lastExchangedAt | string | null | 最後に交換した日時。 |
CardExchangeResult
| フィールド | 型 | 説明 |
|---|---|---|
exchangedAt | string | 成立した日時。 |
meetLogId | string | null | 閲覧者のミートログ ID(削除済みなら null)。 |
eventId | string | null | 閲覧者の記録に入っている会ったイベント。 |
candidateEvents | MeetLogEvent[] | 会ったイベントの候補(2 人とも参加している開催中のイベント。コミュニティとユーザーの交換では、ユーザーが参加している開催中のイベント)。1 件以上なら選んでもらう(1 件のときは eventId に自動で入っている)。 |
CardExchangeLocation
| フィールド | 型 | 説明 |
|---|---|---|
latitude | number必須 | 緯度(-90〜90)。 |
longitude | number必須 | 経度(-180〜180)。 |
accuracy | number | null任意 | 精度(メートル)。 |
{ "latitude": 35.6581, "longitude": 139.7017, "accuracy": 12 }MeetLog
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ミートログ ID。 |
exchangeId | string | 交換 ID(相手の記録と共通)。 |
counterpartId | string | 相手のユーザー ID。相手がコミュニティとして交換したときは、担当した管理者。 |
ownerCommunityId | string | null | コミュニティの記録なら、そのコミュニティの ID(持ち主がコミュニティとして交換した)。個人の記録では null。 |
counterpartCommunityId | string | null | 相手がコミュニティとして交換したときの、そのコミュニティの ID。 |
representative | MeetLogRepresentative | null | コミュニティとして交換を担当した管理者(「コミュニティの誰と」交換したか)。個人どうしの交換では null。 |
exchangedAt | string | 交換した日時。 |
event | MeetLogEvent | null | 会ったイベント。 |
candidateEvents | MeetLogEvent[] | 会ったイベントとして選べる候補。 |
memo | string | null | 自分専用のメモ。コミュニティの記録では、そのコミュニティの管理者全員に見える。 |
location | CardExchangeLocation | null | 自分の端末で取得した位置(相手には見えない)。コミュニティの記録では、担当した管理者の端末の位置で、管理者全員に見える。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
MeetLogRepresentative
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ユーザー ID。 |
slug | string | ユーザー名(プロフィール URL)。 |
firstName | string | null | 名(英語表記)。 |
lastName | string | null | 姓(英語表記)。 |
nativeName | string | null | 母語での氏名。 |
avatarUrl | string | null | アバター画像。 |
MeetLogEvent
| フィールド | 型 | 説明 |
|---|---|---|
id | string | イベント ID。 |
slug | string | イベントのスラッグ。 |
title | string | タイトル。 |
languages | Languages | null | 多言語のタイトルなど。 |
startTime | string | null | 開始(イベントの timezone の壁時計を UTC 表記したもの。Event と同じ)。 |
endTime | string | null | 終了(同上)。 |
timezone | string | イベントのタイムゾーン。 |
thumbnailUrl | string | null | サムネイル。 |
mainImageUrl | string | null | メイン画像。 |
MeetLogContact
| フィールド | 型 | 説明 |
|---|---|---|
user | CardExchangeUser | 相手。相手がコミュニティとして交換したときは、最後に担当した管理者。 |
community | CardExchangeCommunity | null | 相手がコミュニティとして交換したときの、そのコミュニティ。個人どうしの交換では null。 |
exchangeCount | number | 交換した回数。 |
firstExchangedAt | string | null | 初めて交換した日時。 |
lastExchangedAt | string | null | 最後に交換した日時。 |
lastEvent | MeetLogEvent | null | 最後に会ったイベント。 |
MeetLogContactDetail
| フィールド | 型 | 説明 |
|---|---|---|
user / community / exchangeCount / firstExchangedAt / lastExchangedAt / lastEvent | - | MeetLogContact と同じ。 |
myShareEmail | boolean | 自分のメールアドレスをこの相手に開示しているか。 |
mySubscribeNewsletter | boolean | 相手のコミュニティのメルマガを受け取るか(相手がコミュニティのときだけ true になりうる)。true の間は、myShareEmail に関係なくメールアドレスをコミュニティに開示する。 |
email | string | null | 相手が自分に開示しているメールアドレス。公式アプリ以外では常に null。相手がコミュニティのときも常に null(担当した管理者のメールアドレスは開示しない)。 |
MeetLogCommunityScopeContact
| フィールド | 型 | 説明 |
|---|---|---|
user / community / exchangeCount / firstExchangedAt / lastExchangedAt / lastEvent | - | MeetLogContact と同じ(community は常に null)。 |
myShareEmail | boolean | 常に false(コミュニティ側は、担当した管理者のメールアドレスを開示しない)。 |
mySubscribeNewsletter | boolean | 常に false。 |
email | string | null | 相手がコミュニティに開示しているメールアドレス。相手が共有しているか、メルマガを購読しているときに入る。公式アプリ以外では常に null。 |
newsletterSubscribed | boolean | 相手がこのコミュニティのメルマガを購読しているか。 |
newsletterUpdatedAt | string | null | 相手が購読を最後に切り替えた日時(ISO 8601)。 |
lastRepresentative | MeetLogRepresentative | 最後に交換を担当した管理者。 |
通知
Notification
| フィールド | 型 | 説明 |
|---|---|---|
id | string | 通知 ID。 |
userId | string | 宛先ユーザーの ID。 |
type | string | 通知の種類(CHAT_INVITED / NEW_MESSAGE / CHAT_MENTIONED / EVENT_UPDATED / EVENT_ENTRY_APPROVED / EVENT_REMINDER / MEETING_REQUEST / EVENT_ANNOUNCEMENT / COMMUNITY_ANNOUNCEMENT など)。 |
messageParams | Record<string, string> | 文面に差し込むパラメータ(イベント名など)。 |
isRead | boolean | 既読か。 |
relatedId | string | null | 関連するリソースの ID。 |
metadata | NotificationMetadata | null | 遷移先を決めるための付加情報。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
NotificationMetadata
| フィールド | 型 | 説明 |
|---|---|---|
eventId / eventSlug | string | 関連するイベント。 |
communityId / communitySlug | string | 関連するコミュニティ。 |
roomId | string | 関連するチャットルーム。 |
announcementId | string | 関連するお知らせ。 |
含まれるキーは通知の type による。知らないキーは無視してよい。
PushDevice
| フィールド | 型 | 説明 |
|---|---|---|
id | string | デバイス ID。 |
tokenMasked | string | 登録トークンの末尾のみ。トークン全体は返さない。 |
platform | 'IOS' | 'ANDROID' | 'WEB' | プラットフォーム。 |
clientId | string | null | 登録元の OAuth クライアント ID。4S 本体からの登録は null。 |
locale | string | null | 通知本文のロケール。未指定ならユーザー設定を使う。 |
lastUsedAt | string | null | 最後に送信に使われた日時。 |
createdAt | string | 作成日時(ISO 8601) |
updatedAt | string | 更新日時(ISO 8601) |
その他
TagMaster
| フィールド | 型 | 説明 |
|---|---|---|
id | string | タグ候補 ID。 |
name | string | 正規名。保存するのはこちら。 |
nameJa | string | null | 日本語表示名。日本語で表示するときはこちらを優先する。 |
entity | 'user' | 'event' | 'community' | 対象の種別。 |
category | string | null | カテゴリ(user なら industry / skill / hobby)。 |
order | number | 表示順。同順なら name の昇順。 |
TagUsageGroup
| フィールド | 型 | 説明 |
|---|---|---|
entity | 'user' | 'event' | 'community' | 対象の種別。 |
category | string | null | カテゴリ。 |
tags | TagUsageCount[] | そのグループで使われているタグ。 |
TagUsageCount
| フィールド | 型 | 説明 |
|---|---|---|
name | string | タグ名。 |
count | number | 使われている件数。 |
{ "name": "React", "count": 12 }PlacePrediction
| フィールド | 型 | 説明 |
|---|---|---|
placeId | string | 場所 ID。GET /places/:placeId に渡す。 |
text | string | 候補の主テキスト。 |
secondaryText | string | 候補の副テキスト(国名など)。 |
{ "placeId": "ChIJ...", "text": "東京都港区", "secondaryText": "日本" }LabelPrinter
| フィールド | 型 | 説明 |
|---|---|---|
id | string | プリンター ID。 |
name | string | プリンター名。 |
serialNumber | string | 物理プリンターのシリアル番号。 |
media | 'CONTINUOUS_62' | 'CONTINUOUS_29' | 'DIE_CUT_29_90' | 'DIE_CUT_62_100' | 用紙種別。 |
lengthMm | number | 長尺は30〜300 mm、定型は100 mm。 |
enabled | boolean | プリンターが有効か。 |
online | boolean | 有効な受信ステーションの heartbeat が30秒以内か。 |
heartbeatAt | string | null | 最終 heartbeat(ISO 8601)。 |
LabelPrintJob
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ジョブ ID。 |
printerId | string | 登録プリンター ID。 |
entryId | string | null | 参加登録 ID。null は直接テスト印刷。 |
state | 'PREPARED' | 'QUEUED' | 'CLAIMED' | 'PRINTING' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'CANCELLED' | 'EXPIRED' | ジョブ状態。 |
delivery | 'DIRECT' | 'STATION' | 直接印刷または共用ステーション。 |
media | string | ジョブ作成時に固定した用紙。 |
lengthMm | number | ジョブ作成時に固定した長さ。 |
widthPx / heightPx | number | 300 dpi 画像の寸法。 |
errorCode | string | null | 機密情報を含まないエラーコード。 |
createdAt / expiresAt | string | 作成日時と未実行期限(ISO 8601)。 |
LabelPrintContent
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ジョブ ID。 |
printerId | string | 登録プリンター ID。 |
entryId | string | null | 参加登録 ID。null は直接テスト印刷。 |
state | 'PREPARED' | 'QUEUED' | 'CLAIMED' | 'PRINTING' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'CANCELLED' | 'EXPIRED' | ジョブ状態。 |
delivery | 'DIRECT' | 'STATION' | 直接印刷または共用ステーション。 |
media | string | ジョブ作成時に固定した用紙。 |
lengthMm | number | ジョブ作成時に固定した長さ。 |
widthPx / heightPx | number | 300 dpi 画像の寸法。 |
errorCode | string | null | 機密情報を含まないエラーコード。 |
createdAt / expiresAt | string | 作成日時と未実行期限(ISO 8601)。 |
pngBase64 | string | 確定済み300 dpi 白黒 PNG(Base64)。 |
rasterBase64 | string | undefined | raster=true の場合の Brother ラスタ(Base64)。 |
ClaimedLabelPrintJob
| フィールド | 型 | 説明 |
|---|---|---|
id | string | ジョブ ID。 |
printerId | string | 登録プリンター ID。 |
entryId | string | null | 参加登録 ID。null は直接テスト印刷。 |
state | 'PREPARED' | 'QUEUED' | 'CLAIMED' | 'PRINTING' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'CANCELLED' | 'EXPIRED' | ジョブ状態。 |
delivery | 'DIRECT' | 'STATION' | 直接印刷または共用ステーション。 |
media | string | ジョブ作成時に固定した用紙。 |
lengthMm | number | ジョブ作成時に固定した長さ。 |
widthPx / heightPx | number | 300 dpi 画像の寸法。 |
errorCode | string | null | 機密情報を含まないエラーコード。 |
createdAt / expiresAt | string | 作成日時と未実行期限(ISO 8601)。 |
claimToken | string | start/result に必要。ログ出力禁止。 |