# Meeting ## Create `client.meeting.create(MeetingCreateParamsbody, RequestOptionsoptions?): MeetingCreateResponse` **post** `/v1/meetings` Creates a new meeting record. This endpoint only supports creation of meetings in the past. The `$title`, `$startDate`, and `$endDate` fields are required. Only the `$transcript` relationship is writable on create; all other meeting relationships are system-managed. The response is privacy-aware and includes a read-only `accessLevel`. See [Uploading meeting transcripts](/using-the-api/uploading-meeting-transcripts/) for the full file upload and transcript attachment flow. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `meetings:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `body: MeetingCreateParams` - `fields: Fields` Field values for the new MANUAL meeting. System fields use a `$` prefix (for example `$title`, `$startDate`, `$endDate`). Required: `$title`, `$startDate`, and `$endDate`. `$organizerEmail` accepts a single email address when provided; `$attendeeEmails` accepts an array of email addresses. See [Fields and relationships](/using-the-api/fields-and-relationships/) for value type details. - `"$endDate": string` The end time of the meeting in ISO 8601 format. Must be in the past. - `"$startDate": string` The start time of the meeting in ISO 8601 format. Must be in the past. - `"$title": string` The title of the meeting. - `"$attendeeEmails"?: Array` A list of attendee email addresses. - `"$description"?: string | null` A description of the meeting. - `"$meetingUrl"?: string | null` The URL for the meeting. - `"$organizerEmail"?: string | null` The email address of the meeting organizer. This field accepts a single email address. - `"$privacySetting"?: "FULL" | "METADATA" | null` The privacy setting for the meeting (`FULL` or `METADATA`). - `"FULL"` - `"METADATA"` - `autoCreateRecords?: boolean` When true, the initial post-create meeting sync may auto-create account and contact records for external attendees. - `relationships?: Relationships` Relationships to set on the new meeting. Only `$transcript` is writable on create; all other meeting relationships are system-managed. - `"$transcript": string | Array` The ID of the file to attach as the meeting transcript when creating the meeting. Only one transcript can be attached to a meeting. - `string` - `Array` ### Returns - `MeetingCreateResponse` - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. ### Example ```typescript import Lightfield from 'lightfield'; const client = new Lightfield({ apiKey: 'My API Key', }); const meetingCreateResponse = await client.meeting.create({ fields: { $endDate: '$endDate', $startDate: '$startDate', $title: '$title', }, }); console.log(meetingCreateResponse.id); ``` ## Update `client.meeting.update(stringid, MeetingUpdateParamsbody, RequestOptionsoptions?): MeetingUpdateResponse` **post** `/v1/meetings/{id}` Updates an existing meeting by ID. Only included fields and relationships are modified. Only `fields.$privacySetting` and `relationships.$transcript.replace` are writable. Use `$transcript.replace` to set the meeting transcript. Clearing or removing `$transcript` is not supported. The response is privacy-aware and includes a read-only `accessLevel`. See [Uploading meeting transcripts](/using-the-api/uploading-meeting-transcripts/) for the full file upload and transcript attachment flow. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `meetings:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id: string` Unique identifier of the meeting to update. - `body: MeetingUpdateParams` - `fields?: Fields` Field values to update. Only `$privacySetting` is writable, and omitted fields are left unchanged. - `"$privacySetting": "FULL" | "METADATA" | null` The privacy setting for the meeting. - `"FULL"` - `"METADATA"` - `relationships?: Relationships` Relationship operations to apply. Only `$transcript.replace` is supported; removing or clearing `$transcript` is not supported. - `"$transcript": Transcript` - `replace: string` The file ID to set as the meeting transcript. ### Returns - `MeetingUpdateResponse` - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. ### Example ```typescript import Lightfield from 'lightfield'; const client = new Lightfield({ apiKey: 'My API Key', }); const meetingUpdateResponse = await client.meeting.update('id'); console.log(meetingUpdateResponse.id); ``` ## Retrieve `client.meeting.retrieve(stringid, RequestOptionsoptions?): MeetingRetrieveResponse` **get** `/v1/meetings/{id}` Retrieves a single meeting by its ID. Meeting fields and transcript visibility are redacted based on the caller-specific privacy resolution, and the response includes a read-only `accessLevel`. **[Required scope](/using-the-api/scopes/):** `meetings:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id: string` Unique identifier of the meeting to retrieve. ### Returns - `MeetingRetrieveResponse` - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. ### Example ```typescript import Lightfield from 'lightfield'; const client = new Lightfield({ apiKey: 'My API Key', }); const meetingRetrieveResponse = await client.meeting.retrieve('id'); console.log(meetingRetrieveResponse.id); ``` ## List `client.meeting.list(MeetingListParamsquery?, RequestOptionsoptions?): MeetingListResponse` **get** `/v1/meetings` Returns a paginated list of meetings. Use `offset` and `limit` to paginate through results. Each meeting is privacy-filtered per caller, includes a read-only `accessLevel`, and may redact transcript or content fields based on the caller-specific privacy resolution. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination. **[Required scope](/using-the-api/scopes/):** `meetings:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `query: MeetingListParams` - `limit?: number` Maximum number of records to return. Defaults to 25, maximum 25. - `offset?: number` Number of records to skip for pagination. Defaults to 0. ### Returns - `MeetingListResponse` - `data: Array` Array of meeting objects for the current page. - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. - `object: string` The object type, always `"list"`. - `totalCount: number` Total number of entities matching the query. ### Example ```typescript import Lightfield from 'lightfield'; const client = new Lightfield({ apiKey: 'My API Key', }); const meetingListResponse = await client.meeting.list(); console.log(meetingListResponse.data); ``` ## Domain Types ### Meeting Create Response - `MeetingCreateResponse` - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. ### Meeting List Response - `MeetingListResponse` - `data: Array` Array of meeting objects for the current page. - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. - `object: string` The object type, always `"list"`. - `totalCount: number` Total number of entities matching the query. ### Meeting Retrieve Response - `MeetingRetrieveResponse` - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset. ### Meeting Update Response - `MeetingUpdateResponse` - `id: string` Unique identifier for the entity. - `accessLevel: "FULL" | "METADATA"` The caller's resolved access level for this meeting. - `"FULL"` - `"METADATA"` - `createdAt: string` ISO 8601 timestamp of when the entity was created. - `fields: Record` Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug. - `value: string | number | boolean | 3 more | null` The field value, or null if unset. - `string` - `number` - `boolean` - `Array` - `Address` - `city?: string | null` City name. - `country?: string | null` 2-letter ISO 3166-1 alpha-2 country code. - `latitude?: number | null` Latitude coordinate. - `longitude?: number | null` Longitude coordinate. - `postalCode?: string | null` Postal or ZIP code. - `state?: string | null` State or province. - `street?: string | null` Street address line 1. - `street2?: string | null` Street address line 2. - `FullName` - `firstName?: string | null` The contact's first name. - `lastName?: string | null` The contact's last name. - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more` The data type of the field. - `"ADDRESS"` - `"CHECKBOX"` - `"CURRENCY"` - `"DATETIME"` - `"EMAIL"` - `"FULL_NAME"` - `"MARKDOWN"` - `"MULTI_SELECT"` - `"NUMBER"` - `"SINGLE_SELECT"` - `"SOCIAL_HANDLE"` - `"TELEPHONE"` - `"TEXT"` - `"URL"` - `httpLink: string | null` URL to view the entity in the Lightfield web app, or null. - `objectType: "meeting"` Always `meeting`. - `"meeting"` - `relationships: Record` Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). - `cardinality: string` Whether the relationship is `has_one` or `has_many`. - `objectType: string` The type of the related object (e.g. `account`, `contact`). - `values: Array` IDs of the related entities. - `updatedAt: string | null` ISO 8601 timestamp of when the entity was last updated, or null. - `externalId?: string | null` External identifier for the entity, or null if unset.