Schemas

The object types that appear in API requests and responses. The Type column on each endpoint page links to the definitions here.

Common

`PageInfo`

Field	Type	Description
`totalCount`	number	Total number of matching items.
`totalPages`	number	Total number of pages.
`page`	number	Current page number (1-based).
`perPage`	number	Items per page.

{ "totalCount": 100, "totalPages": 5, "page": 1, "perPage": 20 }

`Languages`

Field	Type	Description
`<lang>.title`	stringoptional	Title shown in that language.
`<lang>.name`	stringoptional	Name shown in that language.
`<lang>.description`	stringoptional	Description shown in that language.
`<lang>.label`	stringoptional	Label shown in that language.
`<lang>.bio`	stringoptional	Bio shown in that language.
`<lang>.url`	stringoptional	URL opened in that language.
`<lang>.displayText`	stringoptional	Place text shown in that language.

Which keys appear depends on the data (events and sessions use title / description; communities, tickets, stages and meeting spots use name / description; contacts use label and options use title; custom navigation uses title / url; speakers use title / bio; locations use displayText). Only the languages you specify are overridden; the rest fall back to the default fields.

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

`Contact`

Field	Type	Description
`label`	string \| nulloptional	Display label (e.g. "Support").
`email`	string \| nulloptional	Email address.
`url`	string \| nulloptional	URL, e.g. a contact form.
`x / instagram / facebook / youtube`	string \| nulloptional	Official social accounts.
`languages`	Languages \| nulloptional	Localized labels.

Pass an array of objects (up to 10). A single object is also accepted for backwards compatibility.

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

`Location`

Field	Type	Description
`placeId`	stringoptional	Google Places place ID.
`displayText`	stringoptional	Display text (e.g. Shibuya, Tokyo).
`name / shortName`	stringoptional	Place name and short name.
`title`	stringoptional	Display label for the venue.
`country / countryCode`	stringoptional	Country name and country code (e.g. JP).
`state / locality / city`	stringoptional	State / province, locality and city.
`zipCode / address / building`	stringoptional	Postal code, street address and building name.
`geo`	GeoPoint \| nulloptional	Coordinates.
`googleMapsURI`	stringoptional	Google Maps URL.
`websiteUrl / tel`	stringoptional	Venue website and phone number.
`description`	stringoptional	Additional notes about the venue.
`primary`	booleanoptional	Whether this is the primary venue when several are listed.
`languages`	Languages \| nulloptional	Localized display text.

A user's place of residence uses name / shortName / locality / googleMapsURI, while event and meeting venues use title / websiteUrl / tel / description / primary.

When updating, at least one of placeId, countryCode, displayText, name, locality, city, state or country must be present. Send null or an empty string to clear it.

An event venue accepts either a single object or an array of objects for multiple venues.

{
  "placeId": "ChIJ...",
  "displayText": "東京都渋谷区",
  "countryCode": "JP",
  "state": "東京都",
  "city": "渋谷区",
  "geo": { "lat": 35.6595, "lng": 139.7005 }
}

`GeoPoint`

Field	Type	Description
`lat`	numberrequired	Latitude.
`lng`	numberrequired	Longitude.

{ "lat": 35.6595, "lng": 139.7005 }

`GeoGeometry`

Field	Type	Description
`type`	'Point' \| 'MultiPoint'	Geometry type.
`coordinates`	number[] \| number[][]	Coordinates; [lng, lat] for Point, an array of those for MultiPoint.

{ "type": "Point", "coordinates": [139.7671, 35.6812] }

`GeoFeature`

Field	Type	Description
`type`	'Feature'	GeoJSON Feature.
`geometry`	GeoGeometry	Coordinates; MultiPoint for events with several venues.
`properties`	GeoFeatureProperties	Information about the item the pin represents.

{
  "type": "Feature",
  "geometry": { "type": "Point", "coordinates": [139.7671, 35.6812] },
  "properties": { "eventId": "e1f2a3b4-...", "slug": "tech-conf-2026", "title": "4S Tech Conference 2026" }
}

`GeoFeatureProperties`

Field	Type	Description
`eventId`	string	Event ID.
`slug`	string	Identifier used in the event URL.
`title`	string	Event title.
`languages`	Languages \| null	Localized event title; the event map only.
`playlistItemId`	string	Playlist item ID; the playlist map only.
`kind`	'FOUR_S_EVENT' \| 'EXTERNAL_LINK'	Item kind; the playlist map only.

`CustomStyle`

Field	Type	Description
`theme`	'light' \| 'dark'optional	Base theme.
`primaryColor`	stringoptional	Accent color (CSS color).
`primaryButtonLabelColor`	stringoptional	Label color of primary buttons.
`backgroundColor`	stringoptional	Background color.
`titleTextColor`	stringoptional	Heading text color.
`textColor / textSubColor`	stringoptional	Body and secondary text color.

{
  "theme": "dark",
  "primaryColor": "#4f7cff",
  "backgroundColor": "#101114"
}

`CustomNavigation`

Field	Type	Description
`items`	CustomNavigationItem[]required	Links to display.

{
  "items": [
    { "id": "n1", "title": "参加者向け案内", "url": "https://example.com/guide" }
  ]
}

`CustomNavigationItem`

Field	Type	Description
`id`	stringrequired	Item ID.
`title`	stringrequired	Display label.
`url`	stringrequired	Link target.
`languages`	Languages \| nulloptional	Localized label and link target.

Users and organizations

`User`

Field	Type	Description
`id`	string	User ID.
`slug`	string	Identifier used in the profile URL.
`guest`	boolean	Whether this is a guest user created by organizers.
`firstName / lastName`	string \| null	Given name and family name.
`nativeName`	string \| null	Full name in the user's native writing system.
`avatarUrl`	string \| null	Avatar image URL.
`title`	string \| null	Job title.
`bio`	string \| null	Biography.
`languages`	string[]	Language codes the user speaks.
`lang`	string \| null	Preferred display language.
`tags`	string[]	Tags such as skills; included by list and search endpoints.
`location`	Location \| null	Location; returned by profile detail endpoints.
`socialLinks`	SocialLinks \| null	Social links; returned by profile detail endpoints.
`organizationMembers`	OrganizationMember[]	Memberships (work and education history); returned by profile detail endpoints.
`cardDesign`	string \| null	Business card design: a background image ID, or "custom" for the user's own photo; null when not chosen. Returned by profile detail endpoints.
`cardPhoto`	CardPhoto \| null	The user's own photo for the business card and how it is shown. Returned by profile detail endpoints; for other users only while it is on their card (cardDesign is "custom").
`email`	string	Email address; only for your own profile (GET /users/me) and never via an OAuth access token.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

Deleted users are returned with their name and avatar masked, in places where the row must remain visible (e.g. chat messages).

`SocialLinks`

Field	Type	Description
`x / twitter`	stringoptional	X (formerly Twitter).
`instagram / facebook / youtube`	stringoptional	Instagram / Facebook / YouTube.
`linkedin / github`	stringoptional	LinkedIn / GitHub.
`whatsapp`	stringoptional	WhatsApp.
`website`	stringoptional	Personal website URL.

`UnreadByCategory`

Field	Type	Description
`chat`	number	Unread messages in regular chats.
`event`	number	Unread messages in event chats.
`community`	number	Unread messages in community chats.

{ "chat": 5, "event": 4, "community": 3 }

`Organization`

Field	Type	Description
`id`	string	Organization ID.
`slug`	string	Identifier used in the organization URL.
`name`	string	Organization name.
`type`	string	One of COMPANY / STARTUP / SCHOOL / GOVERNMENT / NON_PROFIT / RESEARCH / VENTURE_CAPITAL / MEDIA / ACCELERATOR / EDUCATIONAL / CONSULTING / COMMUNITY.
`description`	string \| null	Description.
`websiteUrl`	string \| null	Website URL.
`logoUrl / logoDarkUrl`	string \| null	Logo image URLs (including the dark-theme variant).
`memberCount`	number	Number of current members.
`createdBy`	User	Creator; returned by detail endpoints.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`OrganizationMember`

Field	Type	Description
`id`	string	Membership ID.
`organizationId`	string	Organization ID.
`userId`	string	User ID.
`role`	'ADMIN' \| 'MEMBER'	Role within the organization.
`title`	string \| null	Position or title.
`startDate / endDate`	string \| null	Membership period (YYYY-MM-DD); a null endDate means current.
`current`	boolean	Whether the membership is current.
`user`	User	The member; returned by organization member lists.
`organization`	Organization	The organization; returned by a user's membership list.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

Communities

`Community`

Field	Type	Description
`id`	string	Community ID.
`slug`	string	Identifier used in the community URL.
`name`	string	Community name.
`description`	string \| null	Description.
`languages`	Languages \| null	Localized name / description keyed by language code.
`joinType`	'FREE_JOIN' \| 'APPROVAL_REQUIRED' \| 'INVITATION_ONLY'	How members can join.
`visibility`	'PUBLIC' \| 'LIMITED' \| 'PRIVATE'	Visibility.
`logoUrl / logoDarkUrl`	string \| null	Logo image URLs (including the dark-theme variant).
`featured`	boolean	Whether the platform features this community.
`enabledChat`	boolean	Whether community chat is enabled.
`cardDesign`	string \| null	The community's business card design: a background image ID, or "custom" for a photo; null when not chosen.
`cardPhoto`	CardPhoto \| null	The photo for the community's business card and how it is shown. Returned only while it is on the card (cardDesign is "custom"); management endpoints (/manage/communities) return it even while another design is selected.
`memberCount`	number	Number of members.
`tags`	string[]	Tags.
`contact`	Contact[]	Contact entries; returned by detail endpoints.
`createdBy`	User	Creator; returned by detail endpoints.
`membershipRole / membershipTitle`	string \| null	The listed user's membership role and title; returned by a user's community list.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`CommunityMember`

Field	Type	Description
`id`	string	Member ID.
`communityId`	string	Community ID.
`userId`	string	User ID.
`role`	'ADMIN' \| 'MEMBER'	Role within the community.
`status`	'PENDING' \| 'APPROVED' \| 'REJECTED'	Membership status.
`title`	string \| null	Title within the community.
`approvedAt`	string \| null	Approval time.
`user`	User	The member.
`community`	Community	The community; returned by user-oriented endpoints.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`CommunityMemberCounts`

Field	Type	Description
`total`	number	Total number of members.
`byRole`	Record<string, number>	Counts per role (ADMIN / MEMBER).
`byStatus`	Record<string, number>	Counts per status (APPROVED / PENDING / REJECTED).

{
  "total": 120,
  "byRole": { "ADMIN": 2, "MEMBER": 118 },
  "byStatus": { "APPROVED": 118, "PENDING": 2 }
}

Events

`Event`

Field	Type	Description
`id`	string	Event ID.
`slug`	string	Identifier used in the event URL.
`title`	string	Event title.
`catchphrase`	string \| null	Catchphrase.
`description`	string \| null	Description (Markdown).
`languages`	Languages \| null	Localized title / description keyed by language code.
`eventType`	'ONSITE' \| 'ONLINE' \| 'HYBRID'	Event format.
`state`	'DRAFT' \| 'PUBLISHED' \| 'PRIVATE' \| 'CANCELED'	Publication state.
`timezone`	string	Timezone (e.g. Asia/Tokyo); times in schedules are interpreted in it.
`schedules`	EventSchedule[]	One entry per event day.
`location`	Location \| Location[] \| null	Venue; an array when the event has several venues.
`onlineUrl / onlineDescription`	string \| null	Online venue URL and instructions; only returned by the dedicated participant endpoint.
`thumbnailUrl / mainImageUrl`	string \| null	Thumbnail and main image URLs.
`organizers`	EventOrganizer[]	Organizers (a community or a user).
`tickets`	Ticket[]	Ticket types; only on endpoints that include them.
`tags`	string[]	Tags.
`isPaid`	boolean	Whether the event has a paid ticket (price > 0).
`hasEnded`	boolean	Whether the event has ended; returned by public endpoints and on the event embedded in a meeting.
`hasInvitationTickets`	boolean	Whether the event has invitation tickets.
`requiresApproval`	boolean	Whether registration requires approval.
`registrationPaused`	boolean	Whether registration is paused.
`maxParticipants`	number \| null	Participant limit.
`participantListVisibility`	'PUBLIC' \| 'PARTICIPANTS_ONLY' \| 'PRIVATE'	Who can see the participant list.
`enabledTickets / enabledMeetings / enabledChat / enabledSideEvents / enabledReferralTree / enabledConferenceMode`	boolean	Feature toggles.
`featured`	boolean	Whether the platform features this event.
`createdBy`	User	Creator; returned by detail endpoints.
`staffRole`	'ADMIN' \| 'EDITOR' \| 'COORDINATOR' \| 'RECEPTIONIST'	Your staff role; returned by the managed-event list.
`participantCount`	number	Participant count (CONFIRMED + CHECKED_IN); returned by the managed-event list.
`entryState / checkedInAt / entryCreatedAt / entryCount / ticket`	mixed	The listed user's entry state, check-in time, registration time, ticket count and ticket; returned by the entry-based event lists.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`EventSchedule`

Field	Type	Description
`date`	stringrequired	Event date (YYYY-MM-DD).
`doorTime`	string \| nulloptional	Doors-open time (HH:mm).
`startTime`	stringrequired	Start time (HH:mm).
`endTime`	stringrequired	End time (HH:mm).

[
  { "date": "2026-09-01", "doorTime": "09:30", "startTime": "10:00", "endTime": "18:00" }
]

`EventOrganizer`

Field	Type	Description
`id`	stringoptional	Organizer ID.
`communityId`	string \| nulloptional	ID of the organizing community.
`userId`	string \| nulloptional	ID of the organizing user.
`order`	numberresponse only	Display order.
`community`	Community \| nullresponse only	The organizing community; only id / slug / name / logoUrl / logoDarkUrl are included.
`user`	User \| nullresponse only	The organizing user.

`EventDateGroup`

Field	Type	Description
`date`	string	Event date (YYYY-MM-DD).
`events`	Event[]	Events held on that date.

`EventStaff`

Field	Type	Description
`id`	string	Staff ID.
`eventId`	string	Event ID.
`userId`	string	User ID.
`role`	'ADMIN' \| 'EDITOR' \| 'COORDINATOR' \| 'RECEPTIONIST'	Staff role.
`user`	User	The staff member.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`StaffPermissionsByRole`

Field	Type	Description
`ADMIN`	string[]	Permission IDs held by ADMIN.
`EDITOR`	string[]	Permission IDs held by EDITOR.
`COORDINATOR`	string[]	Permission IDs held by COORDINATOR.
`RECEPTIONIST`	string[]	Permission IDs held by RECEPTIONIST.

Event entries

`EventEntry`

Field	Type	Description
`id`	string	Event entry ID.
`eventId`	string	Event ID.
`userId`	string	The participant's user ID.
`state`	'UNUSED' \| 'PENDING' \| 'AWAITING_PAYMENT' \| 'CONFIRMED' \| 'REJECTED' \| 'CHECKED_IN' \| 'CANCELED'	Entry state.
`ticketId`	string \| null	Ticket type ID.
`ticket`	Ticket \| null	The ticket type; only on endpoints that include it.
`user`	User	The participant; only on endpoints that include it.
`speaker`	Speaker \| null	Speaker metadata; null when the entry is not a speaker.
`checkedInAt`	string \| null	Check-in time.
`checkInToken`	string	Check-in token embedded in the QR code; management endpoints only.
`acceptsMeetingRequests`	boolean	Whether the participant accepts meeting requests.
`invitedByEntryId`	string \| null	Entry ID of the inviter.
`invitationGeneration`	number \| null	Invitation generation (depth from the root inviter).
`invitationRootEntryId`	string \| null	Entry ID at the root of the invitation chain.
`canCreateInvitationCode`	boolean	Whether an invitation code can be created from this entry.
`paymentSubtotal / paymentTotal / paymentRefunded`	number \| null	Payment subtotal, total and refunded amount.
`cancellationReason`	string \| null	Cancellation reason.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`Participant`

Field	Type	Description
`id`	string	Event entry ID.
`eventId`	string	Event ID.
`userId`	string	The participant's user ID.
`state`	'CONFIRMED' \| 'CHECKED_IN'	Entry state; only confirmed participants are listed.
`acceptsMeetingRequests`	boolean	Whether the participant accepts meeting requests.
`user`	User	The participant's public profile.
`ticketId`	string \| null	Ticket type ID.
`ticket`	Ticket \| null	The ticket type.
`invitedByEntryId`	string \| null	Entry ID of the inviter.
`_count`	ParticipantCounts	Aggregates for this participant.

`ParticipantCounts`

Field	Type	Description
`invitedEntries`	number	How many people this participant invited.

{ "invitedEntries": 3 }

`ParticipantDemographic`

Field	Type	Description
`key`	string	The attribute value (gender, age group, state or country).
`count`	number	Number of participants.

{ "key": "male", "count": 120 }

`EntryProfileFields`

Field	Type	Description
`avatarUrl / nativeName / birthDate / gender / location / title / bio`	'off' \| 'optional' \| 'required'optional	Whether the field is hidden, optional or required; a missing key means off.

{
  "nativeName": "required",
  "gender": "optional",
  "location": "optional"
}

`EntryProfileAnswers`

Field	Type	Description
`avatarUrl`	string \| nulloptional	Avatar image URL.
`nativeName`	string \| nulloptional	Full name in the native writing system.
`lang`	string \| nulloptional	Language code of the native name; submitted together with nativeName.
`birthDate`	string \| nulloptional	Date of birth (YYYY-MM-DD).
`gender`	'male' \| 'female' \| 'other' \| 'undisclosed' \| nulloptional	Gender.
`location`	Location \| nulloptional	Place of residence.
`title`	string \| nulloptional	Job title.
`bio`	string \| nulloptional	Bio.

Which fields are collected is determined by the event's entryProfileFields. Send null to clear a value.

`EntryActivityLog`

Field	Type	Description
`id`	string	Log ID.
`type`	'ENTRY_CREATED' \| 'STATE_CHANGED' \| 'PAYMENT_COMPLETED' \| 'CHECKOUT_ENTRIES_CREATED' \| 'REFUND_INITIATED' \| 'REFUND_COMPLETED' \| 'TICKET_CHANGED' \| 'HOLDER_TRANSFERRED' \| 'USER_CANCELED'	Type of operation.
`source`	'STAFF_MANAGE' \| 'STAFF_ADMIN' \| 'USER' \| 'STRIPE_WEBHOOK' \| 'SYSTEM'	Where the operation came from.
`payload`	Record<string, unknown>	Details of the operation (e.g. from / to for a state change); the shape depends on the type.
`actorUserId`	string \| null	User ID of the actor; null for system operations.
`actor`	User \| null	The actor.
`createdAt`	string	Operation time (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`

Field	Type	Description
`entryId`	string	The inviter's entry ID; pass it as invitedByEntryId to filter.
`user`	User	The inviter.
`ticket`	Ticket \| null	The inviter's ticket type.

`ReferralEntry`

Field	Type	Description
`id`	string	Event entry ID.
`invitedByEntryId`	string \| null	Entry ID of the inviter.
`invitationGeneration`	number \| null	Invitation generation (0 at the genesis inviter).
`invitationRootEntryId`	string \| null	Entry ID at the root of the invitation chain.
`user`	User \| null	The participant; null for ancestors in an invalid state.
`ticketName`	string \| null	Ticket name.
`invitedEntriesCount`	number	How many people this node directly invited.
`disabled`	boolean	True when the node is hidden because of an invalid state; ancestor lookups only.
`children`	ReferralEntry[]	Direct children, up to childrenLimit; descendant lookups only.
`childrenTotalCount`	number	Total number of direct children; descendant lookups only.
`childrenNextCursor`	string \| null	Cursor to fetch more children, or null; descendant lookups only.

Ancestor lookups can return disabled nodes with user: null (parents in an invalid state). Descendant lookups nest nodes of the same shape under children.

`ReferralRankingItem`

Field	Type	Description
`rank`	number	Rank (1-based).
`rankingType`	'SCORE' \| 'DESCENDANT_COUNT'	Ranking type.
`score`	number	Ranking score.
`entryId`	string	Event entry ID.
`user`	User	The inviter.
`ticketName`	string \| null	Ticket name.
`directInviteCount`	number	Number of people invited directly.
`indirectInviteCount`	number	Number of people invited indirectly.
`descendantCount`	number	Total number of descendants in the invitation chain.
`maxDescendantGeneration`	number	Deepest descendant generation.
`checkedInInviteCount`	number	How many invitees have checked in.

Tickets

`Ticket`

Field	Type	Description
`id`	string	Ticket type ID.
`eventId`	string	Event ID.
`name`	string	Ticket name.
`description`	string \| null	Description.
`languages`	Languages \| null	Localized name / description keyed by language code.
`price`	number	Price in JPY.
`paymentType`	'FREE' \| 'ONSITE_PAYMENT' \| 'PREPAID_STRIPE'	Payment type.
`salesLimit`	number \| null	Sales limit; null means unlimited.
`status`	'DRAFT' \| 'PUBLISHED' \| 'PRIVATE'	Publication state.
`confirmUserBasicInfo`	boolean	Whether basic profile confirmation is required at purchase.
`requiresApproval`	boolean	Whether the organizer must approve the entry.
`transferable`	boolean	Whether the ticket can be transferred.
`displayOrder`	number	Display order.
`isLowStock / isSoldOut`	boolean	Low-stock and sold-out flags; only when salesLimit is set.
`prepaidStripePurchaseAvailable / prepaidStripePurchaseBlockedReason`	mixed	Whether Stripe prepayment is available and, if not, why (NO_STRIPE_PRICE / STRIPE_CONNECT_NOT_CONFIGURED).
`invitationEnabled / invitationTargetTicketId / invitationMaxGenerations / invitationLimit / invitationDiscountEnabled / invitationDiscountPercent / invitationDiscountAmount`	mixed	Invitation settings; management endpoints only.
`uniqueId`	string	Public unique ID of the ticket; management endpoints only.
`_count`	TicketCounts	Sales counts; management endpoints only.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`TicketCounts`

Field	Type	Description
`entries`	number	Number of registrations for the ticket.
`unusedEntries`	number	Number of registrations that have not been used yet.

{ "entries": 120, "unusedEntries": 45 }

`TicketEntryCount`

Field	Type	Description
`ticketId`	string	Ticket type ID.
`name`	string	Ticket name.
`count`	number	Number of registrations for the ticket.

{ "ticketId": "t1a2b3c4-...", "name": "一般チケット", "count": 300 }

`StripeRefund`

Field	Type	Description
`id`	string	Stripe refund ID.
`amount`	number	Refunded amount in JPY.
`status`	string	Status on Stripe (succeeded / pending / failed …).

{ "id": "re_1A2B3C...", "amount": 5000, "status": "succeeded" }

Program and speakers

`Stage`

Field	Type	Description
`id`	string	Stage ID.
`eventId`	string	Event ID.
`name`	string	Stage name.
`description`	string \| null	Description.
`languages`	Languages \| null	Localized name / description keyed by language code.
`capacity`	number \| null	Capacity.
`order`	number	Display order.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`Session`

Field	Type	Description
`id`	string	Session ID.
`eventId`	string	Event ID.
`stageId`	string \| null	Stage ID.
`stage`	Stage \| null	The stage; only on endpoints that include it.
`title`	string	Session title.
`description`	string \| null	Description.
`languages`	Languages \| null	Localized title / description keyed by language code.
`startTime / endTime`	string \| null	Start and end time (ISO 8601).
`status`	'DRAFT' \| 'COMPLETED' \| 'CANCELLED'	Publication state; omitted from public endpoints, which only return published sessions.
`sessionSpeakers`	SessionSpeaker[]	Speaker links; only on endpoints that include them.
`event`	Event	Summary of the event; returned by a user's session list.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`SessionSpeaker`

Field	Type	Description
`id`	stringresponse only	Link ID.
`sessionId`	stringresponse only	Session ID.
`entryId`	stringrequired	The speaker's event entry ID.
`order`	numberoptional	Display order within the session.
`status`	'DRAFT' \| 'PENDING' \| 'CONFIRMED' \| 'REJECTED'optional	Confirmation state; public endpoints only return CONFIRMED links.
`role`	string \| nulloptional	Role within the session (e.g. moderator).
`comment`	string \| nulloptional	Internal note for organizers; management endpoints only.
`speaker`	Speaker \| nullresponse only	The speaker.
`createdAt`	stringresponse only	Creation time (ISO 8601).
`updatedAt`	stringresponse only	Last update time (ISO 8601).

`Speaker`

Field	Type	Description
`id / entryId`	string	Event entry ID (both fields hold the same value).
`eventId`	string	Event ID.
`userId`	string	User ID.
`firstName / lastName / nativeName / avatarUrl / title / bio`	string \| null	Display name, avatar, title and bio; falls back to the user's own values when the speaker has no override.
`languages`	Languages \| null	Localized display fields.
`pickedUp`	boolean	Whether the speaker is featured.
`displayOrder`	number	Display order.
`user`	User	The user.
`sessions`	Session[]	Sessions the speaker appears in; returned by detail endpoints (confirmed and published only).
`overrides`	SpeakerOverrides	The speaker's override values; management endpoints only.
`entry`	EventEntry	Entry state; only id / state / ticketId / checkedInAt / ticket are included. Management endpoints only.
`surveyToken`	string \| null	Token for the speaker survey; management endpoints only.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`SpeakerOverrides`

Field	Type	Description
`firstName / lastName / nativeName`	string \| nulloptional	Overridden display name.
`avatarUrl`	string \| nulloptional	Overridden avatar image.
`title`	string \| nulloptional	Overridden job title.
`bio`	string \| nulloptional	Overridden bio.
`languages`	Languages \| nulloptional	Localized title and bio.

Null falls back to the user's profile, and any string including an empty string overrides it (empty = intentionally blank for this speaker). Fields omitted from an update are left unchanged.

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

`GuestProfile`

Field	Type	Description
`firstName / lastName / nativeName`	string \| nulloptional	Name.
`email`	string \| nulloptional	Email address.
`lang`	string \| nulloptional	Language code of the native name.
`avatarUrl`	string \| nulloptional	Avatar image URL; send null to clear the avatar.
`title`	string \| nulloptional	Job title.
`bio`	string \| nulloptional	Bio.

Surveys

`Question`

Field	Type	Description
`id`	string	Question ID.
`refId`	string \| null	ID of the question this one references (answers are shared).
`eventId / sessionId`	string \| null	The event or session this question belongs to.
`type`	'text' \| 'longText' \| 'email' \| 'url' \| 'singleSelect' \| 'multiSelect' \| 'toggle' \| 'radioButton' \| 'date' \| 'image'	Question type.
`title`	string	Question text.
`description`	string \| null	Additional description.
`languages`	Languages \| null	Localized title / description keyed by language code.
`options`	QuestionOption[]	Options; only for choice questions.
`required`	boolean	Whether an answer is required.
`ticketIds`	string[]	Ticket type IDs this question applies to; an empty array means all tickets.
`order`	number	Display order.
`status`	'DRAFT' \| 'PUBLISHED'	Publication state; public endpoints only return PUBLISHED questions.
`searchable`	boolean	Whether answers may be shown in participant search and public profiles.
`settings`	QuestionSettings \| null	Type-specific settings.
`branchParentId / conditionOptionIds`	mixed	Branching: show this question only when the parent question's listed options are selected.
`showOnDashboard`	boolean	Whether to chart the answers on the management dashboard; management endpoints only.
`answer`	QuestionAnswer \| null	The target user's answer; only on endpoints that return answers.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

The public question list (GET /events/:eventId/questions) returns only id, type, title, description, languages, options, required, order and settings.

`QuestionOption`

Field	Type	Description
`id`	stringoptional	Option ID; specify it to update an existing option. Omit it and one is assigned on save.
`title`	stringrequired	Option label.
`languages`	Languages \| nulloptional	Localized labels ({ [lang]: { title } }).
`deleted`	booleanoptional	Whether the option is deleted; send true to remove it.
`options`	QuestionOption[]optional	Nested options, used for conditional branching.

Options are displayed in their array order.

Answers (QuestionAnswer.answer) and aggregations (QuestionAggregationOption.value) reference options by id. Only the aggregation response renames title to label.

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

`QuestionAnswer`

Field	Type	Description
`id`	stringresponse only	Answer ID.
`questionId`	stringrequired	Question ID.
`userId`	stringresponse only	ID of the user who answered.
`answer`	string[]required	Answer values; option IDs for choice questions and the image URL for image questions.
`user`	Userresponse only	The user who answered; management endpoints only.
`createdAt`	stringresponse only	Creation time (ISO 8601).
`updatedAt`	stringresponse only	Last update time (ISO 8601).

Requests (registration and answer updates) send only questionId and answer. `answer` is a non-empty array of strings, each up to 1000 characters.

`QuestionSettings`

Field	Type	Description
`width`	numberoptional	Image width in pixels (16–4096); image questions only.
`height`	numberoptional	Image height in pixels (16–4096); image questions only.

{ "width": 1200, "height": 630 }

`QuestionAggregation`

Field	Type	Description
`questionId`	string	Question ID.
`questionTitle`	string	Question text.
`questionLanguages`	Languages \| null	Localized question text.
`type`	string	Question type.
`options`	QuestionAggregationOption[]	Counts per option.
`showOnDashboard`	boolean	Whether the question is shown on the dashboard; dashboard aggregation only.

`QuestionAggregationOption`

Field	Type	Description
`value`	string	Option ID.
`label`	string	Option label.
`count`	number	How many people chose the option.
`languages`	Languages \| null	Localized label.

{ "value": "o1", "label": "SNS", "count": 120 }

`SurveyResponse`

Field	Type	Description
`userId`	string	Respondent's user ID.
`entryId`	string	Event entry ID.
`entryType`	'USER' \| 'SPEAKER'	Whether the row is a participant or a speaker.
`displayName`	string	Name to show in the list.
`state`	string	Entry state.
`ticketName`	string	Ticket name.
`isPrepaidPayment`	boolean	Whether the entry was prepaid.
`paymentTotal / paymentRefunded`	number	Amount paid and amount refunded.
`user`	User \| null	The respondent.
`speaker`	Speaker \| null	Speaker metadata; speakers only.
`profileAnswers`	EntryProfileAnswers \| null	Profile fields answered at registration.
`answers`	Record<string, string[]>	Answer values keyed by question ID.
`updatedAt / entryCreatedAt`	string	When the answers were last updated and when the entry was created (ISO 8601).

Announcements

`Announcement`

Field	Type	Description
`id`	string	Announcement ID.
`eventId / communityId`	string \| null	The event or community it belongs to (exactly one of them).
`title`	string	Title.
`content`	string	Body.
`targetStates`	string[]	Entry states to deliver to (event announcements only).
`targetTicketIds`	string[]	Ticket type IDs to deliver to; an empty array means all tickets (event announcements only).
`sendEmail`	boolean	Whether to send email; when false only in-app notification and listing happen.
`deliveryStatus`	'PENDING' \| 'PROCESSING' \| 'SENT' \| 'FAILED' \| 'SKIPPED'	Delivery status; management endpoints only.
`deliveredAt`	string \| null	Delivery completion time.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

Meetings

`Meeting`

Field	Type	Description
`id`	string	Meeting ID.
`eventId`	string	Event ID.
`chatRoomId`	string	ID of the chat room used to arrange it.
`fromUserId`	string	ID of the user who requested the meeting.
`toUserId`	string	ID of the user who received the request.
`status`	'REQUESTED' \| 'CONFIRMED' \| 'CANCELED' \| 'REJECTED'	Meeting status.
`spotId`	string \| null	ID of the confirmed meeting spot.
`startAt / endAt`	string \| null	Confirmed start and end time (ISO 8601).
`tableOrder`	number \| null	Table number within the spot.
`canceledBy / rejectedBy`	string \| null	ID of the user who canceled or rejected the meeting.
`event / chatRoom / fromUser / toUser / spot`	mixed	Related event, chat room, users and spot; only on endpoints that include them. event carries only what a meeting view needs (title, slug, schedules, hasEnded, ...). fromUser / toUser carry display fields only, never the email address.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`MeetingSpot`

Field	Type	Description
`id`	string	Spot ID.
`eventId`	string	Event ID.
`name`	string	Spot name.
`description`	string \| null	Description.
`languages`	Languages \| null	Localized name / description keyed by language code.
`capacity`	number	How many meetings can run at the same time.
`active`	boolean	Whether the spot is available.
`imageUrl`	string \| null	Image URL.
`location`	Location \| null	Location data.
`tableLimit`	number \| null	Maximum number of tables.
`ticketIds`	string[]	Ticket type IDs allowed to use the spot; an empty array means all tickets.
`availableTimes`	Record<string, [string, string]> \| null	[start, end] times (HH:mm) keyed by date (YYYY-MM-DD).
`blockedTimes`	Record<string, [string, string]> \| null	[start, end] times (HH:mm) keyed by date (YYYY-MM-DD).
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`MeetingTimeSlot`

Field	Type	Description
`spotId`	string	Spot ID.
`spotName`	string	Spot name.
`startAt / endAt`	string	Slot start and end time (ISO 8601).
`available`	boolean	Whether the slot is free.

{
  "spotId": "ms1a2b3c-...",
  "spotName": "Meeting Table A",
  "startAt": "2026-06-01T05:00:00.000Z",
  "endAt": "2026-06-01T05:30:00.000Z",
  "available": true
}

`MeetingRequestQuota`

Field	Type	Description
`limit`	number	Maximum number of requests you can create.
`used`	number	Number of requests already created.
`remaining`	number	Number of requests you can still create.

{ "limit": 50, "used": 3, "remaining": 47 }

`Schedule`

Field	Type	Description
`id`	string	Schedule ID.
`userId`	string	User ID.
`eventId`	string \| null	The event it belongs to.
`startAt / endAt`	string	Start and end time (ISO 8601).
`description`	string \| null	What the entry is for.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

Playlists

`Playlist`

Field	Type	Description
`id`	string	Playlist ID.
`communityId`	string \| null	ID of the community that owns it.
`name`	string	Playlist name.
`description`	string \| null	Description.
`languages`	Languages \| null	Localized name / description keyed by language code.
`thumbnailImageUrl`	string \| null	Thumbnail image URL.
`sortOrder`	number	Display order.
`sticky`	boolean	Whether it is pinned to the top of listings.
`featured`	boolean	Whether the platform features this playlist.
`submissionEnabled`	boolean	Whether users may request additions.
`submissionMessage`	string \| null	Message shown to users who request additions.
`itemCount`	number	Number of published items.
`pendingCount`	number	Number of items awaiting approval; management endpoints only.
`community`	Community	The community; only id / name / slug are included, and only on endpoints that include it.
`items`	PlaylistItem[]	Items; only on endpoints that include them.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`PlaylistItem`

Field	Type	Description
`id`	string	Item ID.
`playlistId`	string	Playlist ID.
`sortOrder`	number	Display order.
`kind`	'FOUR_S_EVENT' \| 'EXTERNAL_LINK'	Item kind.
`status`	'PUBLISHED' \| 'PENDING' \| 'REJECTED'	Publication state; PENDING means the addition is awaiting approval.
`eventId`	string \| null	4S event ID (kind = FOUR_S_EVENT).
`sourceUrl`	string \| null	External event URL (kind = EXTERNAL_LINK).
`title`	string	Display title; overridden by the event title for 4S events.
`description`	string \| null	Description.
`imageUrl`	string \| null	Image URL.
`schedules`	EventSchedule[] \| null	Schedules; taken from the event for 4S events.
`location`	Location \| Location[] \| null	Venue; taken from the event for 4S events.
`organizerName / organizerNames`	string \| null	Organizer name; the entered value for external events and the joined organizer names for 4S events.
`startTime / endTime / eventStartTime`	string \| null	Start and end time (ISO 8601), used for the upcoming / past filters.
`eventSlug / eventThumbnailUrl / eventMainImageUrl / eventTags`	mixed	Identifier, images and tags of the linked 4S event.
`requestedById / requestedByName / reviewedAt`	mixed	Who requested the addition and when it was reviewed; management endpoints only.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`PlaylistItemStatusCounts`

Field	Type	Description
`PUBLISHED`	number	Number of published items.
`PENDING`	number	Number of items awaiting approval.
`REJECTED`	number	Number of rejected items.

{ "PUBLISHED": 12, "PENDING": 2, "REJECTED": 1 }

`PlaylistCollectionProperties`

Field	Type	Description
`playlistId`	string	Playlist ID.
`playlistName`	string	Playlist name.

{ "playlistId": "pl1-...", "playlistName": "おすすめイベント" }

`ExternalEventPreview`

Field	Type	Description
`canonicalUrl`	string	The canonical URL; use it when adding the item to a playlist.
`title`	string \| null	Page title.
`description`	string \| null	Page description.
`imageUrl`	string \| null	OGP image URL.
`schedules`	EventSchedule[]	Schedules detected on the page; an empty array when none could be read.

Chat

`ChatRoom`

Field	Type	Description
`id`	string	Chat room ID.
`type`	'DIRECT' \| 'GROUP'	Room type.
`name`	string \| null	Room name; null for DIRECT rooms.
`status`	'ACTIVE' \| 'ARCHIVED'	Room status.
`communityId / eventId`	string \| null	The community or event the room belongs to.
`community / event`	Community \| Event \| null	The linked community or event; only a subset of fields (name, images …) is included.
`createdById`	string	User ID of the creator.
`createdBy`	User	The creator; returned by detail endpoints.
`members`	ChatRoomMember[]	Members.
`lastMessage`	Message \| null	The latest non-system message; returned by the room list.
`unreadCount`	number	Your unread count; returned by the room list.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`ChatRoomMember`

Field	Type	Description
`id`	string	Member ID.
`roomId`	string	Chat room ID.
`userId`	string	User ID.
`status`	'INVITED' \| 'JOINED' \| 'LEFT'	Membership status.
`lastReadAt`	string \| null	When the member last read the room.
`joinedAt / leftAt`	string \| null	When the member joined and left.
`notificationsEnabled`	boolean	Whether notifications are on for this room.
`user`	User	The member.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`Message`

Field	Type	Description
`id`	string	Message ID.
`roomId`	string	Chat room ID.
`type`	'USER' \| 'SYSTEM'	Message type; SYSTEM covers join / leave notices.
`senderId`	string	Sender's user ID.
`sender`	User	The sender; masked when the account is deleted.
`content`	string	Body.
`imageUrl`	string \| null	Image URL for image messages.
`fileId / fileName / fileSize / fileMimeType / fileDeleted / fileFolderName`	mixed	Attachment details; only on messages with an attachment.
`replyToId`	string \| null	ID of the message being replied to.
`replyTo`	MessageReplyTo \| null	Summary of the quoted message.
`reactions`	MessageReaction[]	Reactions; the field is omitted on paths that do not load them.
`deletedAt`	string \| null	Deletion time.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`MessageReaction`

Field	Type	Description
`emoji`	string	The emoji.
`count`	number	Number of people who reacted (the true total even when userIds is truncated).
`userIds`	string[]	IDs of the users who reacted (up to the first 100).
`users`	User[]	The users who reacted, in the order they added it.

The message list and the add / remove endpoints return userIds. To show who reacted, use GET /chat-rooms/:roomId/messages/:messageId/reactions, which returns users instead.

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

`MessageReplyTo`

Field	Type	Description
`id`	string	ID of the quoted message.
`deleted`	boolean	Whether the quoted message was deleted; body and sender are withheld when true.
`senderId`	string \| null	Sender's user ID.
`sender`	User	The sender; masked when the account is deleted.
`content`	string	Body.
`imageUrl`	string \| null	Image URL for image messages.
`fileName`	string	Attachment file name; only for messages with an attachment (no URL is included).

`Mention`

Field	Type	Description
`userId`	stringrequired	User ID of the mentioned user.
`name`	stringrequired	Display name; must match the `@name` in the message body.

[{ "userId": "a1b2c3d4-...", "name": "山田太郎" }]

`ChatImage`

Field	Type	Description
`messageId`	string	ID of the message containing the image.
`senderId`	string	Sender's user ID.
`imageUrl`	string	Image URL.
`createdAt`	string	When it was posted (ISO 8601).

`ChatFolder`

Field	Type	Description
`id`	string	Folder ID.
`name`	string	Folder name.

Used for the folder being listed (folder) and for breadcrumbs. For folders as rows in the listing, see ChatLibraryItem.

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

`ChatLibraryItem`

Field	Type	Description
`type`	'folder' \| 'file'	Entry type.
`id`	string	Folder or file ID.
`name`	string	Display name.
`parentId`	string \| null	Parent folder ID; only when type is folder.
`folderId`	string \| null	Containing folder ID; only when type is file.
`mimeType`	string	MIME type; only when type is file.
`size`	number	Size in bytes; only when type is file.
`messageId`	string \| null	ID of the message the file was attached to; only when type is file.
`createdAt`	string	Creation time (ISO 8601).

Card exchange and meet logs

`CardExchange`

Field	Type	Description
`id`	string	Exchange ID.
`status`	'SCANNED' \| 'PENDING' \| 'ACCEPTING' \| 'ACCEPTED' \| 'EXPIRED'	SCANNED = scanned, PENDING = requested, ACCEPTING = being accepted, ACCEPTED = completed, EXPIRED = expired.
`role`	'REQUESTER' \| 'TARGET'	Viewer's side (requester / person asked).
`counterpart`	CardExchangeUser	The other person. When the other side exchanges as a community, the admin handling the exchange.
`counterpartCommunity`	CardExchangeCommunity \| null	The community when the other side exchanges as one; null for a person.
`myCommunity`	CardExchangeCommunity \| null	The community when the viewer exchanges as one; null for a person.
`expiresAt`	string	Deadline to request or accept; after completion, how long the result stays readable (ISO 8601).
`createdAt`	string	When the QR code was scanned.
`requestedAt`	string \| null	When the request was sent.
`respondedAt`	string \| null	When the exchange was completed.
`myShareEmail`	boolean \| null	Whether the viewer chose to share their email in this exchange; null before choosing.
`defaultShareEmail`	boolean	Initial checkbox value, only when it is the viewer's turn (previous setting, or true). Omitted when the viewer exchanges as a community.
`mySubscribeNewsletter`	boolean \| null	Whether the viewer chose to receive the newsletter in this exchange; null when the other side is not a community or before choosing.
`defaultSubscribeNewsletter`	boolean	Initial value for the newsletter switch, only when it is the viewer's turn and the other side is a community (previous setting, or true).
`previousExchange`	CardExchangeHistory \| null	Earlier exchanges with this counterpart, only when it is the viewer's turn. An exchange as a community is counted separately from person-to-person exchanges.
`result`	CardExchangeResult \| null	The viewer's result after completion.

`CardExchangeUser`

Field	Type	Description
`id`	string	User ID.
`slug`	string	Username (profile URL).
`firstName`	string \| null	First name (Latin).
`lastName`	string \| null	Last name (Latin).
`nativeName`	string \| null	Name in the native script.
`avatarUrl`	string \| null	Avatar image.
`title`	string \| null	Title.
`bio`	string \| null	Bio (only on exchange confirmation, truncated to 500 characters); null in lists.
`cardDesign`	string \| null	Business card design: a background image ID, or "custom" for the user's own photo; null when not chosen.
`cardPhoto`	CardPhoto \| null	The person's own photo on their business card and how it is shown (only while cardDesign is "custom").
`organization`	CardExchangeOrganization \| null	Current organization (excluding education and past roles).

`CardExchangeCommunity`

Field	Type	Description
`id`	string	Community ID.
`slug`	string	Identifier used in the community URL.
`name`	string	Community name.
`languages`	Languages \| null	Localized community names keyed by language code (name only; descriptions are not included).
`logoUrl / logoDarkUrl`	string \| null	Logo image URLs (including the dark-theme variant).
`cardDesign`	string \| null	The community's business card design: a background image ID, or "custom" for a photo; null when not chosen.
`cardPhoto`	CardPhoto \| null	The photo on the community's business card and how it is shown (only while cardDesign is "custom").

Returned to the other side of a card exchange regardless of the community's visibility. On an exchange in progress (CardExchange), the values are those at the time of the scan.

When cardDesign is null (not chosen), the client decides which design to draw. The official 4S app draws a community's card in platinum (metal-03-platinum); the default for a person's card is solid-07-h216.

`CardPhoto`

Field	Type	Description
`url`	string	Photo URL (as returned by POST /users/me/card-photo, or by POST /manage/communities/:id/card-photo for a community's card).
`brightness`	number	Brightness adjustment: an integer from -100 to 100 (1% steps). 0 is the original photo; positive values overlay white and negative values overlay black at that opacity in percent.
`textColor`	"white" \| "black"	Text color drawn over the photo.

`CardExchangeOrganization`

Field	Type	Description
`id`	string	Organization ID.
`name`	string	Organization name.
`slug`	string	Organization slug.
`logoUrl`	string \| null	Logo.
`title`	string \| null	Position in the organization.

`CardExchangeHistory`

Field	Type	Description
`exchangeCount`	number	Number of earlier exchanges.
`lastExchangedAt`	string \| null	When you last exchanged.

`CardExchangeResult`

Field	Type	Description
`exchangedAt`	string	When the exchange was completed.
`meetLogId`	string \| null	The viewer's meet log ID (null once deleted).
`eventId`	string \| null	Event recorded on the viewer's meet log.
`candidateEvents`	MeetLogEvent[]	Candidate events (ongoing events both people registered for; in an exchange between a community and a user, ongoing events the user is registered for). Ask the user to choose when there is at least one (a single candidate is already recorded in eventId).

`CardExchangeLocation`

Field	Type	Description
`latitude`	numberrequired	Latitude (-90 to 90).
`longitude`	numberrequired	Longitude (-180 to 180).
`accuracy`	number \| nulloptional	Accuracy in meters.

{ "latitude": 35.6581, "longitude": 139.7017, "accuracy": 12 }

`MeetLog`

Field	Type	Description
`id`	string	Meet log ID.
`exchangeId`	string	Exchange ID shared with the other person's log.
`counterpartId`	string	The other person's user ID. When the other side exchanged as a community, the admin who handled it.
`ownerCommunityId`	string \| null	The community ID when this is a community's log (the owner exchanged as that community); null for a personal log.
`counterpartCommunityId`	string \| null	The community ID when the other side exchanged as a community.
`representative`	MeetLogRepresentative \| null	The admin who handled the exchange for the community (who in the community you exchanged with); null for person-to-person exchanges.
`exchangedAt`	string	When you exchanged.
`event`	MeetLogEvent \| null	Where you met.
`candidateEvents`	MeetLogEvent[]	Events you can choose as where you met.
`memo`	string \| null	Your private memo. On a community's log, it is visible to all admins of that community.
`location`	CardExchangeLocation \| null	Location from your device (never shown to the other side). On a community's log, it is the location of the handling admin's device and visible to all admins.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`MeetLogRepresentative`

Field	Type	Description
`id`	string	User ID.
`slug`	string	Username (profile URL).
`firstName`	string \| null	First name (Latin).
`lastName`	string \| null	Last name (Latin).
`nativeName`	string \| null	Name in the native script.
`avatarUrl`	string \| null	Avatar image.

`MeetLogEvent`

Field	Type	Description
`id`	string	Event ID.
`slug`	string	Event slug.
`title`	string	Title.
`languages`	Languages \| null	Localized titles and more.
`startTime`	string \| null	Start (wall-clock time in the event's timezone, written as UTC; same as Event).
`endTime`	string \| null	End (same as above).
`timezone`	string	Event time zone.
`thumbnailUrl`	string \| null	Thumbnail.
`mainImageUrl`	string \| null	Main image.

`MeetLogContact`

Field	Type	Description
`user`	CardExchangeUser	The person. When the other side exchanged as a community, the admin who last handled it.
`community`	CardExchangeCommunity \| null	The community when the other side exchanged as one; null for person-to-person exchanges.
`exchangeCount`	number	Number of exchanges.
`firstExchangedAt`	string \| null	First exchange.
`lastExchangedAt`	string \| null	Most recent exchange.
`lastEvent`	MeetLogEvent \| null	Where you last met.

`MeetLogContactDetail`

Field	Type	Description
`user / community / exchangeCount / firstExchangedAt / lastExchangedAt / lastEvent`	-	Same as MeetLogContact.
`myShareEmail`	boolean	Whether you share your email with this person.
`mySubscribeNewsletter`	boolean	Whether you receive the newsletter of the other side's community (can be true only when the other side is a community). While true, your email address is disclosed to the community regardless of myShareEmail.
`email`	string \| null	The email the other person shares with you; always null for non-official apps. Also always null when the other side is a community (the handling admin's email is never disclosed).

`MeetLogCommunityScopeContact`

Field	Type	Description
`user / community / exchangeCount / firstExchangedAt / lastExchangedAt / lastEvent`	-	Same as MeetLogContact (community is always null).
`myShareEmail`	boolean	Always false (the community side never discloses the handling admin's email address).
`mySubscribeNewsletter`	boolean	Always false.
`email`	string \| null	The email the person discloses to the community: set when they share it or subscribe to the newsletter. Always null for non-official apps.
`newsletterSubscribed`	boolean	Whether the person subscribes to this community's newsletter.
`newsletterUpdatedAt`	string \| null	When the person last changed the subscription (ISO 8601).
`lastRepresentative`	MeetLogRepresentative	The admin who last handled the exchange.

Notifications

`Notification`

Field	Type	Description
`id`	string	Notification ID.
`userId`	string	Recipient's user ID.
`type`	string	Notification type (CHAT_INVITED, NEW_MESSAGE, CHAT_MENTIONED, EVENT_UPDATED, EVENT_ENTRY_APPROVED, EVENT_REMINDER, MEETING_REQUEST, EVENT_ANNOUNCEMENT, COMMUNITY_ANNOUNCEMENT, …).
`messageParams`	Record<string, string>	Parameters to fill into the message (event name, …).
`isRead`	boolean	Whether it has been read.
`relatedId`	string \| null	ID of the related resource.
`metadata`	NotificationMetadata \| null	Extra data used to build the link target.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

`NotificationMetadata`

Field	Type	Description
`eventId / eventSlug`	string	The related event.
`communityId / communitySlug`	string	The related community.
`roomId`	string	The related chat room.
`announcementId`	string	The related announcement.

Which keys are present depends on the notification type; unknown keys can be ignored.

`PushDevice`

Field	Type	Description
`id`	string	Device ID.
`tokenMasked`	string	Only the tail of the registration token; the full token is never returned.
`platform`	'IOS' \| 'ANDROID' \| 'WEB'	Platform.
`clientId`	string \| null	OAuth client that registered the device; null when registered by 4S itself.
`locale`	string \| null	Locale for notification text; falls back to the user's setting.
`lastUsedAt`	string \| null	When the device was last used for a delivery.
`createdAt`	string	Creation time (ISO 8601).
`updatedAt`	string	Last update time (ISO 8601).

Other

`TagMaster`

Field	Type	Description
`id`	string	Tag candidate ID.
`name`	string	Canonical name; this is the value to store.
`nameJa`	string \| null	Japanese display name; prefer it when rendering in Japanese.
`entity`	'user' \| 'event' \| 'community'	Entity the tag applies to.
`category`	string \| null	Category (for user: industry / skill / hobby).
`order`	number	Display order; ties are broken by name.

`TagUsageGroup`

Field	Type	Description
`entity`	'user' \| 'event' \| 'community'	Entity type.
`category`	string \| null	Category.
`tags`	TagUsageCount[]	Tags used within the group.

`TagUsageCount`

Field	Type	Description
`name`	string	Tag name.
`count`	number	How many records carry the tag.

{ "name": "React", "count": 12 }

`PlacePrediction`

Field	Type	Description
`placeId`	string	Place ID; pass it to GET /places/:placeId.
`text`	string	Primary text of the suggestion.
`secondaryText`	string	Secondary text of the suggestion (e.g. the country).

{ "placeId": "ChIJ...", "text": "東京都港区", "secondaryText": "日本" }

`LabelPrinter`

Field	Type	Description
`id`	string	Printer ID.
`name`	string	Printer name.
`serialNumber`	string	Physical printer serial number.
`media`	'CONTINUOUS_62' \| 'CONTINUOUS_29' \| 'DIE_CUT_29_90' \| 'DIE_CUT_62_100'	Media type.
`lengthMm`	number	Continuous length is 30–300 mm; die-cut length is 100 mm.
`enabled`	boolean	Whether the printer is enabled.
`online`	boolean	Whether an enabled station has sent a heartbeat within 30 seconds.
`heartbeatAt`	string \| null	Last heartbeat (ISO 8601).

`LabelPrintJob`

Field	Type	Description
`id`	string	Job ID.
`printerId`	string	Registered printer ID.
`entryId`	string \| null	Entry ID; null for a direct test print.
`state`	'PREPARED' \| 'QUEUED' \| 'CLAIMED' \| 'PRINTING' \| 'COMPLETED' \| 'FAILED' \| 'UNKNOWN' \| 'CANCELLED' \| 'EXPIRED'	Job state.
`delivery`	'DIRECT' \| 'STATION'	Direct printing or a shared station.
`media`	string	Media frozen when the job was created.
`lengthMm`	number	Length frozen when the job was created.
`widthPx / heightPx`	number	300 dpi image dimensions.
`errorCode`	string \| null	Error code without sensitive data.
`createdAt / expiresAt`	string	Creation and unstarted-job expiry times (ISO 8601).

`LabelPrintContent`

Field	Type	Description
`id`	string	Job ID.
`printerId`	string	Registered printer ID.
`entryId`	string \| null	Entry ID; null for a direct test print.
`state`	'PREPARED' \| 'QUEUED' \| 'CLAIMED' \| 'PRINTING' \| 'COMPLETED' \| 'FAILED' \| 'UNKNOWN' \| 'CANCELLED' \| 'EXPIRED'	Job state.
`delivery`	'DIRECT' \| 'STATION'	Direct printing or a shared station.
`media`	string	Media frozen when the job was created.
`lengthMm`	number	Length frozen when the job was created.
`widthPx / heightPx`	number	300 dpi image dimensions.
`errorCode`	string \| null	Error code without sensitive data.
`createdAt / expiresAt`	string	Creation and unstarted-job expiry times (ISO 8601).
`pngBase64`	string	Immutable 300 dpi monochrome PNG (Base64).
`rasterBase64`	string \| undefined	Brother raster (Base64), only with raster=true.

`ClaimedLabelPrintJob`

Field	Type	Description
`id`	string	Job ID.
`printerId`	string	Registered printer ID.
`entryId`	string \| null	Entry ID; null for a direct test print.
`state`	'PREPARED' \| 'QUEUED' \| 'CLAIMED' \| 'PRINTING' \| 'COMPLETED' \| 'FAILED' \| 'UNKNOWN' \| 'CANCELLED' \| 'EXPIRED'	Job state.
`delivery`	'DIRECT' \| 'STATION'	Direct printing or a shared station.
`media`	string	Media frozen when the job was created.
`lengthMm`	number	Length frozen when the job was created.
`widthPx / heightPx`	number	300 dpi image dimensions.
`errorCode`	string \| null	Error code without sensitive data.
`createdAt / expiresAt`	string	Creation and unstarted-job expiry times (ISO 8601).
`claimToken`	string	Required by start/result; never log it.