API リファレンス

スキーマ

API のリクエスト・レスポンスに現れるオブジェクトの型をまとめています。各エンドポイントのページの「型」欄は、ここの定義へリンクしています。

共通

PageInfo

フィールド型説明
totalCountnumber条件に一致する総件数。
totalPagesnumber総ページ数。
pagenumber現在のページ番号(1 始まり)。
perPagenumber1 ページあたりの件数。
{ "totalCount": 100, "totalPages": 5, "page": 1, "perPage": 20 }

Languages

フィールド型説明
<lang>.titlestring任意その言語で表示するタイトル。
<lang>.namestring任意その言語で表示する名称。
<lang>.descriptionstring任意その言語で表示する説明。
<lang>.labelstring任意その言語で表示するラベル。
<lang>.biostring任意その言語で表示する自己紹介。
<lang>.urlstring任意その言語で開く URL。
<lang>.displayTextstring任意その言語で表示する場所のテキスト。

どのキーを持つかは対象のデータによる(イベント・セッションは title / description、コミュニティ・チケット・ステージ・ミーティング場所は name / description、連絡先は label、選択肢は title、カスタムナビゲーションは title / url、登壇者は title / bio、場所は displayText)。指定した言語のみ上書きされ、未指定の言語は既定のフィールドが使われる。

{
  "ja": { "title": "オープニング基調講演", "description": "..." },
  "en": { "title": "Opening Keynote", "description": "..." }
}

Contact

フィールド型説明
labelstring | null任意表示ラベル(例: お問い合わせ窓口)。
emailstring | null任意メールアドレス。
urlstring | null任意問い合わせフォームなどの URL。
x / instagram / facebook / youtubestring | null任意公式 SNS。
languagesLanguages | null任意言語別のラベル。

オブジェクトの配列(最大 10 件)で指定する。後方互換のため単一オブジェクトも受け付ける。

[
  {
    "label": "お問い合わせ",
    "email": "contact@example.com",
    "languages": { "en": { "label": "Contact" } }
  }
]

Location

フィールド型説明
placeIdstring任意Google Places の場所 ID。
displayTextstring任意表示用のテキスト(例: 東京都渋谷区)。
name / shortNamestring任意場所名・略称。
titlestring任意会場の表示ラベル。
country / countryCodestring任意国名と国コード(JP など)。
state / locality / citystring任意都道府県・州、地域、市区町村。
zipCode / address / buildingstring任意郵便番号・住所・建物名。
geoGeoPoint | null任意座標。
googleMapsURIstring任意Google マップの URL。
websiteUrl / telstring任意会場のウェブサイト・電話番号。
descriptionstring任意会場の補足説明。
primaryboolean任意複数会場のうち主要な会場か。
languagesLanguages | 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

フィールド型説明
latnumber必須緯度。
lngnumber必須経度。
{ "lat": 35.6595, "lng": 139.7005 }

GeoGeometry

フィールド型説明
type'Point' | 'MultiPoint'ジオメトリの種別。
coordinatesnumber[] | number[][]座標。Point は [lng, lat]、MultiPoint はその配列。
{ "type": "Point", "coordinates": [139.7671, 35.6812] }

GeoFeature

フィールド型説明
type'Feature'GeoJSON の Feature。
geometryGeoGeometry座標。複数会場のイベントは MultiPoint。
propertiesGeoFeaturePropertiesピンに紐づく項目の情報。
{
  "type": "Feature",
  "geometry": { "type": "Point", "coordinates": [139.7671, 35.6812] },
  "properties": { "eventId": "e1f2a3b4-...", "slug": "tech-conf-2026", "title": "4S Tech Conference 2026" }
}

GeoFeatureProperties

フィールド型説明
eventIdstringイベント ID。
slugstringイベントページの識別子。
titlestringイベント名。
languagesLanguages | null言語別のイベント名。イベントの地図のみ。
playlistItemIdstringプレイリスト項目 ID。プレイリストの地図のみ。
kind'FOUR_S_EVENT' | 'EXTERNAL_LINK'項目の種別。プレイリストの地図のみ。

CustomStyle

フィールド型説明
theme'light' | 'dark'任意ベースのテーマ。
primaryColorstring任意アクセント色(CSS の色表記)。
primaryButtonLabelColorstring任意主要ボタンの文字色。
backgroundColorstring任意背景色。
titleTextColorstring任意見出しの文字色。
textColor / textSubColorstring任意本文・補助テキストの文字色。
{
  "theme": "dark",
  "primaryColor": "#4f7cff",
  "backgroundColor": "#101114"
}

CustomNavigation

フィールド型説明
itemsCustomNavigationItem[]必須表示するリンク。
{
  "items": [
    { "id": "n1", "title": "参加者向け案内", "url": "https://example.com/guide" }
  ]
}

CustomNavigationItem

フィールド型説明
idstring必須項目 ID。
titlestring必須表示名。
urlstring必須リンク先 URL。
languagesLanguages | null任意言語別の表示名・リンク先。

ユーザー・組織

User

フィールド型説明
idstringユーザー ID。
slugstringプロフィール URL に使う識別子。
guestbooleanゲストユーザー(運営が代理登録した登壇者・参加者)か。
firstName / lastNamestring | null名・姓。
nativeNamestring | null母語表記の氏名。
avatarUrlstring | nullアバター画像の URL。
titlestring | null肩書き。
biostring | null自己紹介。
languagesstring[]話せる言語のコード。
langstring | null既定の表示言語。
tagsstring[]タグ(スキルなど)。一覧・検索系の API で付く。
locationLocation | null所在地。プロフィール詳細で返る。
socialLinksSocialLinks | nullSNS リンク。プロフィール詳細で返る。
organizationMembersOrganizationMember[]所属(職歴・学歴)。プロフィール詳細で返る。
cardDesignstring | null名刺カードのデザイン。背景画像の ID か、自分の写真を使う "custom"。未設定は null。プロフィール詳細で返る。
cardPhotoCardPhoto | null名刺カードに使う自分の写真と見せ方。プロフィール詳細で返る。他人の分は、名刺カードに使っている(cardDesign が "custom")ときだけ返る。
emailstringメールアドレス。自分自身の情報(GET /users/me)のみ。OAuth アクセストークン経由では返さない。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

退会済みユーザーは、表示名・アバターをマスクした状態で返る(チャットのメッセージなど、行を残す必要がある箇所のみ)。

UnreadByCategory

フィールド型説明
chatnumber通常のチャットの未読メッセージ数。
eventnumberイベントチャットの未読メッセージ数。
communitynumberコミュニティチャットの未読メッセージ数。
{ "chat": 5, "event": 4, "community": 3 }

Organization

フィールド型説明
idstring組織 ID。
slugstring組織ページの識別子。
namestring組織名。
typestringCOMPANY / STARTUP / SCHOOL / GOVERNMENT / NON_PROFIT / RESEARCH / VENTURE_CAPITAL / MEDIA / ACCELERATOR / EDUCATIONAL / CONSULTING / COMMUNITY のいずれか。
descriptionstring | null説明。
websiteUrlstring | nullウェブサイトの URL。
logoUrl / logoDarkUrlstring | nullロゴ画像(ダークテーマ用を含む)の URL。
memberCountnumber在籍中のメンバー数。
createdByUser作成者。詳細取得で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

OrganizationMember

フィールド型説明
idstring所属 ID。
organizationIdstring組織 ID。
userIdstringユーザー ID。
role'ADMIN' | 'MEMBER'組織内のロール。
titlestring | null役職・肩書き。
startDate / endDatestring | null在籍期間(YYYY-MM-DD)。endDate が null なら在籍中。
currentboolean現在も在籍しているか。
userUser対象ユーザー。組織のメンバー一覧で返る。
organizationOrganization所属先の組織。ユーザーの所属一覧で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

コミュニティ

Community

フィールド型説明
idstringコミュニティ ID。
slugstringコミュニティページの識別子。
namestringコミュニティ名。
descriptionstring | null説明。
languagesLanguages | null言語別の name / description。
joinType'FREE_JOIN' | 'APPROVAL_REQUIRED' | 'INVITATION_ONLY'参加方法。
visibility'PUBLIC' | 'LIMITED' | 'PRIVATE'公開範囲。
logoUrl / logoDarkUrlstring | nullロゴ画像(ダークテーマ用を含む)の URL。
featuredboolean運営によるピックアップ。
enabledChatbooleanコミュニティチャットが有効か。
cardDesignstring | nullコミュニティの名刺カードのデザイン。背景画像の ID か、写真を使う "custom"。未設定は null。
cardPhotoCardPhoto | nullコミュニティの名刺カードに使う写真と見せ方。名刺カードに使っている(cardDesign が "custom")ときだけ返る。管理用の API(/manage/communities)では、別のデザインに替えている間も返る。
memberCountnumberメンバー数。
tagsstring[]タグ。
contactContact[]連絡先。詳細取得で返る。
createdByUser作成者。詳細取得で返る。
membershipRole / membershipTitlestring | null閲覧対象ユーザーの参加ロール・肩書き。ユーザーの参加コミュニティ一覧で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

CommunityMember

フィールド型説明
idstringメンバー ID。
communityIdstringコミュニティ ID。
userIdstringユーザー ID。
role'ADMIN' | 'MEMBER'コミュニティ内のロール。
status'PENDING' | 'APPROVED' | 'REJECTED'参加状態。
titlestring | nullコミュニティ内の肩書き。
approvedAtstring | null承認日時。
userUser対象ユーザー。
communityCommunityコミュニティ。ユーザー起点の API で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

CommunityMemberCounts

フィールド型説明
totalnumberメンバーの総数。
byRoleRecord<string, number>ロード(ADMIN / MEMBER)ごとの件数。
byStatusRecord<string, number>参加状態(APPROVED / PENDING / REJECTED)ごとの件数。
{
  "total": 120,
  "byRole": { "ADMIN": 2, "MEMBER": 118 },
  "byStatus": { "APPROVED": 118, "PENDING": 2 }
}

イベント

Event

フィールド型説明
idstringイベント ID。
slugstringイベントページの識別子。
titlestringイベント名。
catchphrasestring | nullキャッチコピー。
descriptionstring | null説明(Markdown)。
languagesLanguages | null言語別の title / description。
eventType'ONSITE' | 'ONLINE' | 'HYBRID'開催形式。
state'DRAFT' | 'PUBLISHED' | 'PRIVATE' | 'CANCELED'公開状態。
timezonestringタイムゾーン(例: Asia/Tokyo)。schedules の時刻はこのタイムゾーンで解釈する。
schedulesEventSchedule[]開催日ごとの日程。
locationLocation | Location[] | null会場。複数会場のときは配列。
onlineUrl / onlineDescriptionstring | nullオンライン会場の URL と案内。参加者向けの専用 API のみで返る。
thumbnailUrl / mainImageUrlstring | nullサムネイル・メイン画像の URL。
organizersEventOrganizer[]主催者(コミュニティまたはユーザー)。
ticketsTicket[]チケット種別。含める API のみ。
tagsstring[]タグ。
isPaidboolean有料チケット(price > 0)があるか。
hasEndedboolean終了済みか。公開 API と、ミーティングに含まれるイベントで返る。
hasInvitationTicketsboolean招待用チケットがあるか。
requiresApprovalboolean参加登録に承認が必要か。
registrationPausedboolean参加登録を一時停止しているか。
maxParticipantsnumber | null定員。
participantListVisibility'PUBLIC' | 'PARTICIPANTS_ONLY' | 'PRIVATE'参加者一覧の公開範囲。
enabledTickets / enabledMeetings / enabledChat / enabledSideEvents / enabledReferralTree / enabledConferenceModeboolean各機能の有効・無効。
featuredboolean運営によるピックアップ。
createdByUser作成者。詳細取得で返る。
staffRole'ADMIN' | 'EDITOR' | 'COORDINATOR' | 'RECEPTIONIST'自分のスタッフロール。管理イベント一覧で返る。
participantCountnumber参加者数(CONFIRMED + CHECKED_IN)。管理イベント一覧で返る。
entryState / checkedInAt / entryCreatedAt / entryCount / ticketmixed自分(または対象ユーザー)の参加登録の状態・チェックイン時刻・登録日時・枚数・チケット。参加イベント一覧で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

EventSchedule

フィールド型説明
datestring必須開催日(YYYY-MM-DD)。
doorTimestring | null任意開場時刻(HH:mm)。
startTimestring必須開始時刻(HH:mm)。
endTimestring必須終了時刻(HH:mm)。
[
  { "date": "2026-09-01", "doorTime": "09:30", "startTime": "10:00", "endTime": "18:00" }
]

EventOrganizer

フィールド型説明
idstring任意主催者 ID。
communityIdstring | null任意主催コミュニティの ID。
userIdstring | null任意主催ユーザーの ID。
ordernumberレスポンスのみ表示順。
communityCommunity | nullレスポンスのみ主催コミュニティ。id / slug / name / logoUrl / logoDarkUrl のみを含む。
userUser | nullレスポンスのみ主催ユーザー。

EventDateGroup

フィールド型説明
datestring開催日(YYYY-MM-DD)。
eventsEvent[]その日に開催されるイベント。

EventStaff

フィールド型説明
idstringスタッフ ID。
eventIdstringイベント ID。
userIdstringユーザー ID。
role'ADMIN' | 'EDITOR' | 'COORDINATOR' | 'RECEPTIONIST'スタッフロール。
userUser対象ユーザー。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

StaffPermissionsByRole

フィールド型説明
ADMINstring[]ADMIN が持つ権限 ID。
EDITORstring[]EDITOR が持つ権限 ID。
COORDINATORstring[]COORDINATOR が持つ権限 ID。
RECEPTIONISTstring[]RECEPTIONIST が持つ権限 ID。

参加登録

EventEntry

フィールド型説明
idstring参加登録 ID。
eventIdstringイベント ID。
userIdstring参加者のユーザー ID。
state'UNUSED' | 'PENDING' | 'AWAITING_PAYMENT' | 'CONFIRMED' | 'REJECTED' | 'CHECKED_IN' | 'CANCELED'参加状態。
ticketIdstring | nullチケット種別 ID。
ticketTicket | nullチケット種別。含める API のみ。
userUser参加者。含める API のみ。
speakerSpeaker | null登壇者メタデータ。登壇者でない参加登録では null。
checkedInAtstring | nullチェックイン日時。
checkInTokenstringチェックイン用トークン(QR に埋め込む)。管理 API のみ。
acceptsMeetingRequestsbooleanミーティングリクエストを受け付けるか。
invitedByEntryIdstring | null招待元の参加登録 ID。
invitationGenerationnumber | null招待の世代(招待元から何段目か)。
invitationRootEntryIdstring | null招待チェーンの起点の参加登録 ID。
canCreateInvitationCodebooleanこの参加登録から招待コードを作れるか。
paymentSubtotal / paymentTotal / paymentRefundednumber | null決済の小計・合計・返金済み金額。
cancellationReasonstring | nullキャンセル理由。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

Participant

フィールド型説明
idstring参加登録 ID。
eventIdstringイベント ID。
userIdstring参加者のユーザー ID。
state'CONFIRMED' | 'CHECKED_IN'参加状態(確定済みの参加者のみが一覧に出る)。
acceptsMeetingRequestsbooleanミーティングリクエストを受け付けるか。
userUser参加者の公開プロフィール。
ticketIdstring | nullチケット種別 ID。
ticketTicket | nullチケット種別。
invitedByEntryIdstring | null招待元の参加登録 ID。
_countParticipantCountsこの参加者に紐づく集計。

ParticipantCounts

フィールド型説明
invitedEntriesnumberこの参加者が招待した人数。
{ "invitedEntries": 3 }

ParticipantDemographic

フィールド型説明
keystring属性の値(性別・年代・都道府県・国)。
countnumber件数。
{ "key": "male", "count": 120 }

EntryProfileFields

フィールド型説明
avatarUrl / nativeName / birthDate / gender / location / title / bio'off' | 'optional' | 'required'任意その項目を出さない / 任意 / 必須。キーが無い場合は off と同じ。
{
  "nativeName": "required",
  "gender": "optional",
  "location": "optional"
}

EntryProfileAnswers

フィールド型説明
avatarUrlstring | null任意アバター画像の URL。
nativeNamestring | null任意母語表記の氏名。
langstring | null任意母語の言語コード。nativeName とセットで登録する。
birthDatestring | null任意生年月日(YYYY-MM-DD)。
gender'male' | 'female' | 'other' | 'undisclosed' | null任意性別。
locationLocation | null任意居住地。
titlestring | null任意肩書き。
biostring | null任意自己紹介。

収集する項目はイベントの entryProfileFields で決まる。null を送るとその項目をクリアする。

EntryActivityLog

フィールド型説明
idstringログ 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'操作の経路。
payloadRecord<string, unknown>操作の内容(状態変更の from / to など、種類ごとに異なる)。
actorUserIdstring | null操作したユーザーの ID。システム操作では null。
actorUser | null操作したユーザー。
createdAtstring操作日時(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

フィールド型説明
entryIdstring招待者の参加登録 ID。invitedByEntryId に指定して絞り込む。
userUser招待者。
ticketTicket | null招待者のチケット種別。

ReferralEntry

フィールド型説明
idstring参加登録 ID。
invitedByEntryIdstring | null招待元の参加登録 ID。
invitationGenerationnumber | null招待の世代(起点が 0)。
invitationRootEntryIdstring | null招待チェーンの起点となる参加登録 ID。
userUser | null参加者。無効な state の祖先では null。
ticketNamestring | nullチケット名。
invitedEntriesCountnumberこのノードが直接招待した人数。
disabledboolean無効な state で内容を伏せている場合に true。祖先の取得のみ。
childrenReferralEntry[]直接の子ノード(childrenLimit 件まで)。子孫の取得のみ。
childrenTotalCountnumber直接の子の総数。子孫の取得のみ。
childrenNextCursorstring | null子の続きを取得するカーソル。無ければ null。子孫の取得のみ。

祖先の取得では disabled / user: null がありうる(無効な state の親)。子孫の取得では children に同じ形のノードが再帰的に入る。

ReferralRankingItem

フィールド型説明
ranknumber順位(1 始まり)。
rankingType'SCORE' | 'DESCENDANT_COUNT'ランキング種別。
scorenumberランキングのスコア。
entryIdstring参加登録 ID。
userUser招待者。
ticketNamestring | nullチケット名。
directInviteCountnumber直接招待した人数。
indirectInviteCountnumber間接的に招待した人数。
descendantCountnumber招待チェーンの子孫の総数。
maxDescendantGenerationnumber子孫の最大世代数。
checkedInInviteCountnumber招待した人のうちチェックイン済みの人数。

チケット

Ticket

フィールド型説明
idstringチケット種別 ID。
eventIdstringイベント ID。
namestringチケット名。
descriptionstring | null説明。
languagesLanguages | null言語別の name / description。
pricenumber価格(日本円)。
paymentType'FREE' | 'ONSITE_PAYMENT' | 'PREPAID_STRIPE'支払い方法。
salesLimitnumber | null販売上限数。null は無制限。
status'DRAFT' | 'PUBLISHED' | 'PRIVATE'公開状態。
confirmUserBasicInfoboolean購入時に基本情報の確認を求めるか。
requiresApprovalboolean参加に主催者の承認が必要か。
transferableboolean譲渡できるか。
displayOrdernumber表示順。
isLowStock / isSoldOutboolean残りわずか・売り切れ。salesLimit が設定されている場合のみ。
prepaidStripePurchaseAvailable / prepaidStripePurchaseBlockedReasonmixed事前決済が購入可能か、不可の場合の理由(NO_STRIPE_PRICE / STRIPE_CONNECT_NOT_CONFIGURED)。
invitationEnabled / invitationTargetTicketId / invitationMaxGenerations / invitationLimit / invitationDiscountEnabled / invitationDiscountPercent / invitationDiscountAmountmixed招待機能の設定。管理 API のみ。
uniqueIdstringチケットの一意な公開 ID。管理 API のみ。
_countTicketCounts販売数の集計。管理 API のみ。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

TicketCounts

フィールド型説明
entriesnumberそのチケットでの参加登録数。
unusedEntriesnumber未使用(未チェックイン)の参加登録数。
{ "entries": 120, "unusedEntries": 45 }

TicketEntryCount

フィールド型説明
ticketIdstringチケット種別 ID。
namestringチケット名。
countnumberそのチケットでの参加登録数。
{ "ticketId": "t1a2b3c4-...", "name": "一般チケット", "count": 300 }

StripeRefund

フィールド型説明
idstringStripe の返金 ID。
amountnumber返金額(日本円)。
statusstringStripe 上の状態(succeeded / pending / failed など)。
{ "id": "re_1A2B3C...", "amount": 5000, "status": "succeeded" }

プログラム・登壇者

Stage

フィールド型説明
idstringステージ ID。
eventIdstringイベント ID。
namestringステージ名。
descriptionstring | null説明。
languagesLanguages | null言語別の name / description。
capacitynumber | null収容人数。
ordernumber表示順。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

Session

フィールド型説明
idstringセッション ID。
eventIdstringイベント ID。
stageIdstring | nullステージ ID。
stageStage | nullステージ。含める API のみ。
titlestringセッション名。
descriptionstring | null説明。
languagesLanguages | null言語別の title / description。
startTime / endTimestring | null開始・終了日時(ISO 8601)。
status'DRAFT' | 'COMPLETED' | 'CANCELLED'公開状態。公開 API では返さない(公開済みのセッションのみ返す)。
sessionSpeakersSessionSpeaker[]登壇者の紐づけ。含める API のみ。
eventEvent開催イベントの概要。ユーザーの登壇セッション一覧で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

SessionSpeaker

フィールド型説明
idstringレスポンスのみ紐づけ ID。
sessionIdstringレスポンスのみセッション ID。
entryIdstring必須登壇者の参加登録 ID。
ordernumber任意セッション内の表示順。
status'DRAFT' | 'PENDING' | 'CONFIRMED' | 'REJECTED'任意登壇の確定状態。公開 API では CONFIRMED のみ返る。
rolestring | null任意セッション内での役割(モデレーターなど)。
commentstring | null任意運営用のメモ。管理 API のみ。
speakerSpeaker | nullレスポンスのみ登壇者。
createdAtstringレスポンスのみ作成日時(ISO 8601)
updatedAtstringレスポンスのみ更新日時(ISO 8601)

Speaker

フィールド型説明
id / entryIdstring参加登録 ID(同じ値)。
eventIdstringイベント ID。
userIdstringユーザー ID。
firstName / lastName / nativeName / avatarUrl / title / biostring | null表示用の氏名・アバター・肩書き・自己紹介。登壇者側の上書き値が無ければユーザーの値を返す。
languagesLanguages | null言語別の表示項目。
pickedUpboolean注目登壇者としてピックアップするか。
displayOrdernumber表示順。
userUserユーザー。
sessionsSession[]登壇セッション。詳細取得で返る(確定 + 公開済みのみ)。
overridesSpeakerOverrides登壇者側で上書きした値。管理 API のみ。
entryEventEntry参加登録の状態。id / state / ticketId / checkedInAt / ticket のみを含む。管理 API のみ。
surveyTokenstring | null登壇者アンケート用トークン。管理 API のみ。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

SpeakerOverrides

フィールド型説明
firstName / lastName / nativeNamestring | null任意表示名の上書き。
avatarUrlstring | null任意アバター画像の上書き。
titlestring | null任意肩書きの上書き。
biostring | null任意自己紹介の上書き。
languagesLanguages | null任意言語別の肩書き・自己紹介。

null はユーザー情報を使い、空文字を含む文字列はその値で上書きする(空文字 = 登壇者としては空)。更新時に指定しなかった項目は変更されない。

{
  "firstName": null,
  "lastName": null,
  "nativeName": null,
  "avatarUrl": null,
  "title": "Principal Engineer",
  "bio": null,
  "languages": null
}

GuestProfile

フィールド型説明
firstName / lastName / nativeNamestring | null任意氏名。
emailstring | null任意メールアドレス。
langstring | null任意母語の言語コード。
avatarUrlstring | null任意アバター画像の URL。null を送るとアバターを消す。
titlestring | null任意肩書き。
biostring | null任意自己紹介。

アンケート

Question

フィールド型説明
idstring設問 ID。
refIdstring | null他の設問を参照する場合の参照先 ID(回答を共有する)。
eventId / sessionIdstring | null紐づくイベント・セッション。
type'text' | 'longText' | 'email' | 'url' | 'singleSelect' | 'multiSelect' | 'toggle' | 'radioButton' | 'date' | 'image'設問タイプ。
titlestring設問文。
descriptionstring | null補足説明。
languagesLanguages | null言語別の title / description。
optionsQuestionOption[]選択肢。選択式の設問のみ。
requiredboolean回答が必須か。
ticketIdsstring[]対象のチケット種別 ID。空配列は全チケット対象。
ordernumber表示順。
status'DRAFT' | 'PUBLISHED'公開状態。公開 API では PUBLISHED のみ返る。
searchableboolean参加者検索・公開プロフィールでこの設問の回答を見せるか。
settingsQuestionSettings | null設問タイプ別の設定。
branchParentId / conditionOptionIdsmixed条件分岐。親設問の指定した選択肢が選ばれたときのみ表示する。
showOnDashboardboolean管理ダッシュボードに集計グラフを出すか。管理 API のみ。
answerQuestionAnswer | null対象ユーザーの回答。回答付きで返す API のみ。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

公開の設問一覧(GET /events/:eventId/questions)は id / type / title / description / languages / options / required / order / settings のみを返す。

QuestionOption

フィールド型説明
idstring任意選択肢 ID。既存の選択肢を更新するときに指定する。省略すると保存時に採番される。
titlestring必須選択肢のラベル。
languagesLanguages | null任意言語別のラベル({ [lang]: { title } })。
deletedboolean任意削除済みか。true を送ると選択肢を削除する。
optionsQuestionOption[]任意入れ子の選択肢。条件分岐で使う。

選択肢の表示順は options 配列の順番で決まる。

回答(QuestionAnswer.answer)や集計(QuestionAggregationOption.value)では、選択肢を id で参照する。集計のレスポンスだけは title を label という名前で返す。

[
  { "id": "a1b2c3d4-...", "title": "SNS", "languages": { "en": { "title": "Social media" } } },
  { "title": "知人の紹介" }
]

QuestionAnswer

フィールド型説明
idstringレスポンスのみ回答 ID。
questionIdstring必須設問 ID。
userIdstringレスポンスのみ回答したユーザーの ID。
answerstring[]必須回答値。選択式は選択肢 ID、画像は画像 URL が入る。
userUserレスポンスのみ回答したユーザー。管理 API のみ。
createdAtstringレスポンスのみ作成日時(ISO 8601)
updatedAtstringレスポンスのみ更新日時(ISO 8601)

参加登録・回答更新のリクエストで送るのは questionId と answer だけ。answer は 1 要素以上の文字列配列で、各要素 1000 文字以内。

QuestionSettings

フィールド型説明
widthnumber任意画像の幅(px)。16〜4096 の整数。image タイプのみ。
heightnumber任意画像の高さ(px)。16〜4096 の整数。image タイプのみ。
{ "width": 1200, "height": 630 }

QuestionAggregation

フィールド型説明
questionIdstring設問 ID。
questionTitlestring設問文。
questionLanguagesLanguages | null言語別の設問文。
typestring設問タイプ。
optionsQuestionAggregationOption[]選択肢ごとの件数。
showOnDashboardbooleanダッシュボードに表示する設問か。ダッシュボード集計のみ。

QuestionAggregationOption

フィールド型説明
valuestring選択肢 ID。
labelstring選択肢のラベル。
countnumberその選択肢を選んだ人数。
languagesLanguages | null言語別のラベル。
{ "value": "o1", "label": "SNS", "count": 120 }

SurveyResponse

フィールド型説明
userIdstring回答者のユーザー ID。
entryIdstring参加登録 ID。
entryType'USER' | 'SPEAKER'参加者か登壇者か。
displayNamestring一覧に表示する氏名。
statestring参加状態。
ticketNamestringチケット名。
isPrepaidPaymentboolean事前決済か。
paymentTotal / paymentRefundednumber支払い済み額・返金済み額。
userUser | null回答者。
speakerSpeaker | null登壇者メタデータ。登壇者のみ。
profileAnswersEntryProfileAnswers | null参加登録時に回答したプロフィール項目。
answersRecord<string, string[]>設問 ID をキーにした回答値。
updatedAt / entryCreatedAtstring回答の最終更新日時・参加登録日時(ISO 8601)。

お知らせ

Announcement

フィールド型説明
idstringお知らせ ID。
eventId / communityIdstring | null紐づくイベント・コミュニティ(どちらか一方)。
titlestring件名。
contentstring本文。
targetStatesstring[]配信対象の参加状態(イベントお知らせのみ)。
targetTicketIdsstring[]配信対象のチケット種別 ID。空配列は全チケット対象(イベントお知らせのみ)。
sendEmailbooleanメールを送るか。false ならアプリ内通知と掲載のみ。
deliveryStatus'PENDING' | 'PROCESSING' | 'SENT' | 'FAILED' | 'SKIPPED'配信状況。管理 API のみ。
deliveredAtstring | null配信完了日時。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

ミーティング

Meeting

フィールド型説明
idstringミーティング ID。
eventIdstringイベント ID。
chatRoomIdstring調整に使うチャットルーム ID。
fromUserIdstringリクエストしたユーザーの ID。
toUserIdstringリクエストされたユーザーの ID。
status'REQUESTED' | 'CONFIRMED' | 'CANCELED' | 'REJECTED'ミーティングの状態。
spotIdstring | null確定したミーティング場所の ID。
startAt / endAtstring | null確定した開始・終了日時(ISO 8601)。
tableOrdernumber | null場所内のテーブル番号。
canceledBy / rejectedBystring | nullキャンセル・拒否したユーザーの ID。
event / chatRoom / fromUser / toUser / spotmixed関連するイベント・チャットルーム・相手・場所。含める API のみ。event はタイトル・slug・日程(schedules)・hasEnded など、ミーティングの表示に使う項目だけを含む。fromUser / toUser は表示用の項目だけで、メールアドレスなどは含まない。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

MeetingSpot

フィールド型説明
idstring場所 ID。
eventIdstringイベント ID。
namestring場所名。
descriptionstring | null説明。
languagesLanguages | null言語別の name / description。
capacitynumber同時に実施できるミーティング数。
activeboolean利用可能か。
imageUrlstring | null場所の画像 URL。
locationLocation | null場所の位置情報。
tableLimitnumber | nullテーブル数の上限。
ticketIdsstring[]利用できるチケット種別 ID。空配列は全チケット対象。
availableTimesRecord<string, [string, string]> | null日付(YYYY-MM-DD)をキーにした [開始時刻, 終了時刻](HH:mm)。
blockedTimesRecord<string, [string, string]> | null日付(YYYY-MM-DD)をキーにした [開始時刻, 終了時刻](HH:mm)。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

MeetingTimeSlot

フィールド型説明
spotIdstring場所 ID。
spotNamestring場所名。
startAt / endAtstring枠の開始・終了日時(ISO 8601)。
availableboolean空いているか。
{
  "spotId": "ms1a2b3c-...",
  "spotName": "Meeting Table A",
  "startAt": "2026-06-01T05:00:00.000Z",
  "endAt": "2026-06-01T05:30:00.000Z",
  "available": true
}

MeetingRequestQuota

フィールド型説明
limitnumber作成できるリクエストの上限。
usednumber作成済みの件数。
remainingnumber残り作成できる件数。
{ "limit": 50, "used": 3, "remaining": 47 }

Schedule

フィールド型説明
idstring予定 ID。
userIdstringユーザー ID。
eventIdstring | null紐づくイベント ID。
startAt / endAtstring開始・終了日時(ISO 8601)。
descriptionstring | null予定の内容。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

プレイリスト

Playlist

フィールド型説明
idstringプレイリスト ID。
communityIdstring | null作成したコミュニティの ID。
namestringプレイリスト名。
descriptionstring | null説明。
languagesLanguages | null言語別の name / description。
thumbnailImageUrlstring | nullサムネイル画像の URL。
sortOrdernumber表示順。
stickyboolean一覧の先頭に固定するか。
featuredboolean運営によるピックアップ。
submissionEnabledboolean一般ユーザーからの追加申請を受け付けるか。
submissionMessagestring | null追加申請時に表示する運営からのメッセージ。
itemCountnumber公開中のアイテム数。
pendingCountnumber承認待ちのアイテム数。管理 API のみ。
communityCommunityコミュニティ。id / name / slug のみを含む。含める API のみ。
itemsPlaylistItem[]アイテム。含める API のみ。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

PlaylistItem

フィールド型説明
idstringアイテム ID。
playlistIdstringプレイリスト ID。
sortOrdernumber表示順。
kind'FOUR_S_EVENT' | 'EXTERNAL_LINK'アイテムの種類。
status'PUBLISHED' | 'PENDING' | 'REJECTED'公開状態。PENDING は追加申請中。
eventIdstring | null4S イベントの ID(kind = FOUR_S_EVENT)。
sourceUrlstring | null外部イベントの URL(kind = EXTERNAL_LINK)。
titlestring表示名。4S イベントではイベント名で上書きされる。
descriptionstring | null説明。
imageUrlstring | null画像の URL。
schedulesEventSchedule[] | null開催日程。4S イベントではイベント側の値。
locationLocation | Location[] | null会場。4S イベントではイベント側の値。
organizerName / organizerNamesstring | null主催者名(外部イベントは入力値、4S イベントは主催者名の連結)。
startTime / endTime / eventStartTimestring | null開始・終了日時(ISO 8601)。upcoming / past の絞り込みに使う。
eventSlug / eventThumbnailUrl / eventMainImageUrl / eventTagsmixed4S イベントの識別子・画像・タグ。
requestedById / requestedByName / reviewedAtmixed追加申請したユーザーと審査日時。管理 API のみ。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

PlaylistItemStatusCounts

フィールド型説明
PUBLISHEDnumber公開中の件数。
PENDINGnumber承認待ちの件数。
REJECTEDnumber却下された件数。
{ "PUBLISHED": 12, "PENDING": 2, "REJECTED": 1 }

PlaylistCollectionProperties

フィールド型説明
playlistIdstringプレイリスト ID。
playlistNamestringプレイリスト名。
{ "playlistId": "pl1-...", "playlistName": "おすすめイベント" }

ExternalEventPreview

フィールド型説明
canonicalUrlstring正規化した URL。プレイリストに登録するときはこれを使う。
titlestring | nullページのタイトル。
descriptionstring | nullページの説明。
imageUrlstring | nullOGP 画像の URL。
schedulesEventSchedule[]ページから読み取れた開催日程。取得できなければ空配列。

チャット

ChatRoom

フィールド型説明
idstringチャットルーム ID。
type'DIRECT' | 'GROUP'ルームの種類。
namestring | nullルーム名。DIRECT では null。
status'ACTIVE' | 'ARCHIVED'ルームの状態。
communityId / eventIdstring | null紐づくコミュニティ・イベント。
community / eventCommunity | Event | null紐づくコミュニティ・イベント。名前・画像など一部のフィールドのみを含む。
createdByIdstring作成者のユーザー ID。
createdByUser作成者。詳細取得で返る。
membersChatRoomMember[]メンバー。
lastMessageMessage | null最新のメッセージ(システムメッセージを除く)。一覧で返る。
unreadCountnumber自分の未読件数。一覧で返る。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

ChatRoomMember

フィールド型説明
idstringメンバー ID。
roomIdstringチャットルーム ID。
userIdstringユーザー ID。
status'INVITED' | 'JOINED' | 'LEFT'参加状態。
lastReadAtstring | null最後に既読にした日時。
joinedAt / leftAtstring | null参加・退出日時。
notificationsEnabledbooleanこのルームの通知が ON か。
userUser対象ユーザー。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

Message

フィールド型説明
idstringメッセージ ID。
roomIdstringチャットルーム ID。
type'USER' | 'SYSTEM'メッセージの種類。SYSTEM は参加・退出などの通知。
senderIdstring送信者のユーザー ID。
senderUser送信者。退会済みの場合はマスクされる。
contentstring本文。
imageUrlstring | null画像メッセージの URL。
fileId / fileName / fileSize / fileMimeType / fileDeleted / fileFolderNamemixed添付ファイルの情報。添付があるメッセージのみ。
replyToIdstring | null返信元のメッセージ ID。
replyToMessageReplyTo | null返信元の概要。
reactionsMessageReaction[]リアクション。取得していない経路ではフィールド自体を返さない。
deletedAtstring | null削除日時。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

MessageReaction

フィールド型説明
emojistring絵文字。
countnumber押した人数(userIds が打ち切られていても総数)。
userIdsstring[]押したユーザーの ID(先頭 100 件まで)。
usersUser[]押したユーザー(押された順)。

メッセージ一覧とリアクションの追加・削除では userIds を返す。誰が押したかを表示するときは GET /chat-rooms/:roomId/messages/:messageId/reactions を使う(こちらは users を返す)。

{ "emoji": "👍", "count": 2, "userIds": ["a1b2c3d4-...", "b2c3d4e5-..."] }

MessageReplyTo

フィールド型説明
idstring返信元のメッセージ ID。
deletedboolean返信元が削除済みか。true のときは本文・送信者を返さない。
senderIdstring | null送信者のユーザー ID。
senderUser送信者。退会済みの場合はマスクされる。
contentstring本文。
imageUrlstring | null画像メッセージの URL。
fileNamestring添付ファイル名。添付があるメッセージのみ(URL は含まない)。

Mention

フィールド型説明
userIdstring必須メンションする相手のユーザー ID。
namestring必須本文中の `@name` と一致する表示名。
[{ "userId": "a1b2c3d4-...", "name": "山田太郎" }]

ChatImage

フィールド型説明
messageIdstring画像を含むメッセージの ID。
senderIdstring送信者のユーザー ID。
imageUrlstring画像の URL。
createdAtstring送信日時(ISO 8601)。

ChatFolder

フィールド型説明
idstringフォルダ ID。
namestringフォルダ名。

表示中のフォルダ(folder)とパンくず(breadcrumbs)で使う。一覧の行としてのフォルダは ChatLibraryItem を参照。

{ "id": "fd1a2b3c-...", "name": "議事録" }

ChatLibraryItem

フィールド型説明
type'folder' | 'file'行の種別。
idstringフォルダ ID またはファイル ID。
namestring表示名。
parentIdstring | null親フォルダ ID。type が folder のときのみ。
folderIdstring | null所属フォルダ ID。type が file のときのみ。
mimeTypestringMIME タイプ。type が file のときのみ。
sizenumberバイト数。type が file のときのみ。
messageIdstring | nullファイルを添付したメッセージの ID。type が file のときのみ。
createdAtstring作成日時(ISO 8601)。

名刺交換・ミートログ

CardExchange

フィールド型説明
idstring交換 ID。
status'SCANNED' | 'PENDING' | 'ACCEPTING' | 'ACCEPTED' | 'EXPIRED'SCANNED = スキャンした、PENDING = 申し込んだ、ACCEPTING = 承認処理中、ACCEPTED = 成立、EXPIRED = 期限切れ。
role'REQUESTER' | 'TARGET'閲覧者の立場(申し込んだ側 / 申し込まれた側)。
counterpartCardExchangeUser相手の要約。相手がコミュニティとして交換しているときは、交換を担当している管理者。
counterpartCommunityCardExchangeCommunity | null相手がコミュニティとして交換しているときの、そのコミュニティ。個人としての交換では null。
myCommunityCardExchangeCommunity | null閲覧者がコミュニティとして交換しているときの、そのコミュニティ。個人としての交換では null。
expiresAtstring交換中は申し込み・承認の期限、成立後は結果を読める期限(ISO 8601)。
createdAtstringスキャンした日時。
requestedAtstring | null申し込んだ日時。
respondedAtstring | null成立した日時。
myShareEmailboolean | null閲覧者がこの交換で選んだメールアドレスの開示。まだ選んでいなければ null。
defaultShareEmailbooleanチェックボックスの初期値(閲覧者が操作する番のときだけ。前回の開示設定、なければ true)。閲覧者がコミュニティとして交換するときは返さない。
mySubscribeNewsletterboolean | null閲覧者がこの交換で選んだ「メルマガを受け取る」。相手がコミュニティでない・まだ選んでいなければ null。
defaultSubscribeNewsletterboolean「メルマガを受け取る」の初期値(閲覧者が操作する番で、相手がコミュニティのときだけ。前回の設定、なければ true)。
previousExchangeCardExchangeHistory | null前回までの交換(閲覧者が操作する番のときだけ)。コミュニティとしての交換は、個人どうしの交換とは別の相手として数える。
resultCardExchangeResult | null成立後の閲覧者側の結果。

CardExchangeUser

フィールド型説明
idstringユーザー ID。
slugstringユーザー名(プロフィール URL)。
firstNamestring | null名(英語表記)。
lastNamestring | null姓(英語表記)。
nativeNamestring | null母語での氏名。
avatarUrlstring | nullアバター画像。
titlestring | null肩書き。
biostring | null自己紹介(交換の確認画面でだけ入る。500 文字で切る)。一覧では null。
cardDesignstring | null名刺カードのデザイン。背景画像の ID か、自分の写真を使う "custom"。未設定は null。
cardPhotoCardPhoto | null名刺カードに使っている自分の写真と見せ方(cardDesign が "custom" のときだけ)。
organizationCardExchangeOrganization | null現在の所属(学歴・終了した経歴は除く)。

CardExchangeCommunity

フィールド型説明
idstringコミュニティ ID。
slugstringコミュニティページの識別子。
namestringコミュニティ名。
languagesLanguages | null言語別のコミュニティ名(name のみ。description は含まない)。
logoUrl / logoDarkUrlstring | nullロゴ画像(ダークテーマ用を含む)の URL。
cardDesignstring | nullコミュニティの名刺カードのデザイン。背景画像の ID か、写真を使う "custom"。未設定は null。
cardPhotoCardPhoto | nullコミュニティの名刺カードに使っている写真と見せ方(cardDesign が "custom" のときだけ)。

コミュニティの公開範囲(visibility)に関係なく、名刺交換の相手には返します。交換中(CardExchange)の値は、スキャンした時点のものです。

cardDesign が null(未設定)のときにどのデザインで描くかは、クライアントが決めます。4S の公式アプリは、コミュニティの名刺カードをプラチナ(metal-03-platinum)で描きます(人の名刺カードの既定は solid-07-h216)。

CardPhoto

フィールド型説明
urlstring写真の URL(POST /users/me/card-photo が返したもの。コミュニティの名刺カードでは POST /manage/communities/:id/card-photo が返したもの)。
brightnessnumber明度の調整。-100〜100 の整数(1% 刻み)。0 が元の写真で、正は白、負は黒のレイヤーをその濃さ(%)で重ねる。
textColor"white" | "black"写真の上の文字色。

CardExchangeOrganization

フィールド型説明
idstring組織 ID。
namestring組織名。
slugstring組織のスラッグ。
logoUrlstring | nullロゴ。
titlestring | null組織での役職。

CardExchangeHistory

フィールド型説明
exchangeCountnumberこれまでの交換回数。
lastExchangedAtstring | null最後に交換した日時。

CardExchangeResult

フィールド型説明
exchangedAtstring成立した日時。
meetLogIdstring | null閲覧者のミートログ ID(削除済みなら null)。
eventIdstring | null閲覧者の記録に入っている会ったイベント。
candidateEventsMeetLogEvent[]会ったイベントの候補(2 人とも参加している開催中のイベント。コミュニティとユーザーの交換では、ユーザーが参加している開催中のイベント)。1 件以上なら選んでもらう(1 件のときは eventId に自動で入っている)。

CardExchangeLocation

フィールド型説明
latitudenumber必須緯度(-90〜90)。
longitudenumber必須経度(-180〜180)。
accuracynumber | null任意精度(メートル)。
{ "latitude": 35.6581, "longitude": 139.7017, "accuracy": 12 }

MeetLog

フィールド型説明
idstringミートログ ID。
exchangeIdstring交換 ID(相手の記録と共通)。
counterpartIdstring相手のユーザー ID。相手がコミュニティとして交換したときは、担当した管理者。
ownerCommunityIdstring | nullコミュニティの記録なら、そのコミュニティの ID(持ち主がコミュニティとして交換した)。個人の記録では null。
counterpartCommunityIdstring | null相手がコミュニティとして交換したときの、そのコミュニティの ID。
representativeMeetLogRepresentative | nullコミュニティとして交換を担当した管理者(「コミュニティの誰と」交換したか)。個人どうしの交換では null。
exchangedAtstring交換した日時。
eventMeetLogEvent | null会ったイベント。
candidateEventsMeetLogEvent[]会ったイベントとして選べる候補。
memostring | null自分専用のメモ。コミュニティの記録では、そのコミュニティの管理者全員に見える。
locationCardExchangeLocation | null自分の端末で取得した位置(相手には見えない)。コミュニティの記録では、担当した管理者の端末の位置で、管理者全員に見える。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

MeetLogRepresentative

フィールド型説明
idstringユーザー ID。
slugstringユーザー名(プロフィール URL)。
firstNamestring | null名(英語表記)。
lastNamestring | null姓(英語表記)。
nativeNamestring | null母語での氏名。
avatarUrlstring | nullアバター画像。

MeetLogEvent

フィールド型説明
idstringイベント ID。
slugstringイベントのスラッグ。
titlestringタイトル。
languagesLanguages | null多言語のタイトルなど。
startTimestring | null開始(イベントの timezone の壁時計を UTC 表記したもの。Event と同じ)。
endTimestring | null終了(同上)。
timezonestringイベントのタイムゾーン。
thumbnailUrlstring | nullサムネイル。
mainImageUrlstring | nullメイン画像。

MeetLogContact

フィールド型説明
userCardExchangeUser相手。相手がコミュニティとして交換したときは、最後に担当した管理者。
communityCardExchangeCommunity | null相手がコミュニティとして交換したときの、そのコミュニティ。個人どうしの交換では null。
exchangeCountnumber交換した回数。
firstExchangedAtstring | null初めて交換した日時。
lastExchangedAtstring | null最後に交換した日時。
lastEventMeetLogEvent | null最後に会ったイベント。

MeetLogContactDetail

フィールド型説明
user / community / exchangeCount / firstExchangedAt / lastExchangedAt / lastEvent-MeetLogContact と同じ。
myShareEmailboolean自分のメールアドレスをこの相手に開示しているか。
mySubscribeNewsletterboolean相手のコミュニティのメルマガを受け取るか(相手がコミュニティのときだけ true になりうる)。true の間は、myShareEmail に関係なくメールアドレスをコミュニティに開示する。
emailstring | null相手が自分に開示しているメールアドレス。公式アプリ以外では常に null。相手がコミュニティのときも常に null(担当した管理者のメールアドレスは開示しない)。

MeetLogCommunityScopeContact

フィールド型説明
user / community / exchangeCount / firstExchangedAt / lastExchangedAt / lastEvent-MeetLogContact と同じ(community は常に null)。
myShareEmailboolean常に false(コミュニティ側は、担当した管理者のメールアドレスを開示しない)。
mySubscribeNewsletterboolean常に false。
emailstring | null相手がコミュニティに開示しているメールアドレス。相手が共有しているか、メルマガを購読しているときに入る。公式アプリ以外では常に null。
newsletterSubscribedboolean相手がこのコミュニティのメルマガを購読しているか。
newsletterUpdatedAtstring | null相手が購読を最後に切り替えた日時(ISO 8601)。
lastRepresentativeMeetLogRepresentative最後に交換を担当した管理者。

通知

Notification

フィールド型説明
idstring通知 ID。
userIdstring宛先ユーザーの ID。
typestring通知の種類(CHAT_INVITED / NEW_MESSAGE / CHAT_MENTIONED / EVENT_UPDATED / EVENT_ENTRY_APPROVED / EVENT_REMINDER / MEETING_REQUEST / EVENT_ANNOUNCEMENT / COMMUNITY_ANNOUNCEMENT など)。
messageParamsRecord<string, string>文面に差し込むパラメータ(イベント名など)。
isReadboolean既読か。
relatedIdstring | null関連するリソースの ID。
metadataNotificationMetadata | null遷移先を決めるための付加情報。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

NotificationMetadata

フィールド型説明
eventId / eventSlugstring関連するイベント。
communityId / communitySlugstring関連するコミュニティ。
roomIdstring関連するチャットルーム。
announcementIdstring関連するお知らせ。

含まれるキーは通知の type による。知らないキーは無視してよい。

PushDevice

フィールド型説明
idstringデバイス ID。
tokenMaskedstring登録トークンの末尾のみ。トークン全体は返さない。
platform'IOS' | 'ANDROID' | 'WEB'プラットフォーム。
clientIdstring | null登録元の OAuth クライアント ID。4S 本体からの登録は null。
localestring | null通知本文のロケール。未指定ならユーザー設定を使う。
lastUsedAtstring | null最後に送信に使われた日時。
createdAtstring作成日時(ISO 8601)
updatedAtstring更新日時(ISO 8601)

その他

TagMaster

フィールド型説明
idstringタグ候補 ID。
namestring正規名。保存するのはこちら。
nameJastring | null日本語表示名。日本語で表示するときはこちらを優先する。
entity'user' | 'event' | 'community'対象の種別。
categorystring | nullカテゴリ(user なら industry / skill / hobby)。
ordernumber表示順。同順なら name の昇順。

TagUsageGroup

フィールド型説明
entity'user' | 'event' | 'community'対象の種別。
categorystring | nullカテゴリ。
tagsTagUsageCount[]そのグループで使われているタグ。

TagUsageCount

フィールド型説明
namestringタグ名。
countnumber使われている件数。
{ "name": "React", "count": 12 }

PlacePrediction

フィールド型説明
placeIdstring場所 ID。GET /places/:placeId に渡す。
textstring候補の主テキスト。
secondaryTextstring候補の副テキスト(国名など)。
{ "placeId": "ChIJ...", "text": "東京都港区", "secondaryText": "日本" }

LabelPrinter

フィールド型説明
idstringプリンター ID。
namestringプリンター名。
serialNumberstring物理プリンターのシリアル番号。
media'CONTINUOUS_62' | 'CONTINUOUS_29' | 'DIE_CUT_29_90' | 'DIE_CUT_62_100'用紙種別。
lengthMmnumber長尺は30〜300 mm、定型は100 mm。
enabledbooleanプリンターが有効か。
onlineboolean有効な受信ステーションの heartbeat が30秒以内か。
heartbeatAtstring | null最終 heartbeat(ISO 8601)。

LabelPrintJob

フィールド型説明
idstringジョブ ID。
printerIdstring登録プリンター ID。
entryIdstring | null参加登録 ID。null は直接テスト印刷。
state'PREPARED' | 'QUEUED' | 'CLAIMED' | 'PRINTING' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'CANCELLED' | 'EXPIRED'ジョブ状態。
delivery'DIRECT' | 'STATION'直接印刷または共用ステーション。
mediastringジョブ作成時に固定した用紙。
lengthMmnumberジョブ作成時に固定した長さ。
widthPx / heightPxnumber300 dpi 画像の寸法。
errorCodestring | null機密情報を含まないエラーコード。
createdAt / expiresAtstring作成日時と未実行期限(ISO 8601)。

LabelPrintContent

フィールド型説明
idstringジョブ ID。
printerIdstring登録プリンター ID。
entryIdstring | null参加登録 ID。null は直接テスト印刷。
state'PREPARED' | 'QUEUED' | 'CLAIMED' | 'PRINTING' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'CANCELLED' | 'EXPIRED'ジョブ状態。
delivery'DIRECT' | 'STATION'直接印刷または共用ステーション。
mediastringジョブ作成時に固定した用紙。
lengthMmnumberジョブ作成時に固定した長さ。
widthPx / heightPxnumber300 dpi 画像の寸法。
errorCodestring | null機密情報を含まないエラーコード。
createdAt / expiresAtstring作成日時と未実行期限(ISO 8601)。
pngBase64string確定済み300 dpi 白黒 PNG(Base64)。
rasterBase64string | undefinedraster=true の場合の Brother ラスタ(Base64)。

ClaimedLabelPrintJob

フィールド型説明
idstringジョブ ID。
printerIdstring登録プリンター ID。
entryIdstring | null参加登録 ID。null は直接テスト印刷。
state'PREPARED' | 'QUEUED' | 'CLAIMED' | 'PRINTING' | 'COMPLETED' | 'FAILED' | 'UNKNOWN' | 'CANCELLED' | 'EXPIRED'ジョブ状態。
delivery'DIRECT' | 'STATION'直接印刷または共用ステーション。
mediastringジョブ作成時に固定した用紙。
lengthMmnumberジョブ作成時に固定した長さ。
widthPx / heightPxnumber300 dpi 画像の寸法。
errorCodestring | null機密情報を含まないエラーコード。
createdAt / expiresAtstring作成日時と未実行期限(ISO 8601)。
claimTokenstringstart/result に必要。ログ出力禁止。