Lightfield Meetings API

openapi: 3.1.1
info:
  title: API Reference Accounts Meetings API
  version: 0.0.0
tags:
- name: Meetings
paths:
  /v1/meetings:
    post:
      operationId: meeting.create
      summary: Create a meeting
      description: '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 `$account` and `$opportunity` relationships are read-only and are derived from the meeting''s `$contact` attendees and the accounts/opportunities those contacts belong to. The response is privacy-aware and includes a read-only `accessLevel`. See <u>[Uploading meeting transcripts](/using-the-api/uploading-meeting-transcripts/)</u> 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'
      security:
      - bearerAuth: []
      parameters:
      - name: Lightfield-Version
        in: header
        required: true
        description: Required API version header. Requests may error without it.
        schema:
          type: string
          enum:
          - '2026-03-01'
          default: '2026-03-01'
        example: '2026-03-01'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  properties:
                    $title:
                      type: string
                      description: The title of the meeting.
                    $startDate:
                      type: string
                      description: The start time of the meeting in ISO 8601 format. Must be in the past.
                    $endDate:
                      type: string
                      description: The end time of the meeting in ISO 8601 format. Must be in the past.
                    $description:
                      anyOf:
                      - type: string
                      - type: 'null'
                      description: A description of the meeting.
                    $meetingUrl:
                      anyOf:
                      - type: string
                      - type: 'null'
                      description: The URL for the meeting.
                    $organizerEmail:
                      anyOf:
                      - type: string
                      - type: 'null'
                      description: The email address of the meeting organizer. This field accepts a single email address.
                    $attendeeEmails:
                      type: array
                      items:
                        type: string
                      description: A list of attendee email addresses.
                    $privacySetting:
                      anyOf:
                      - enum:
                        - FULL
                        - METADATA
                      - type: 'null'
                      description: The privacy setting for the meeting (`FULL` or `METADATA`).
                  required:
                  - $title
                  - $startDate
                  - $endDate
                  additionalProperties: false
                  description: '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 <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for value type details.'
                relationships:
                  type: object
                  properties:
                    $transcript:
                      anyOf:
                      - type: string
                      - type: array
                        items:
                          type: string
                      description: The ID of the file to attach as the meeting transcript when creating the meeting. Only one transcript can be attached to a meeting.
                  required:
                  - $transcript
                  additionalProperties: false
                  description: Relationships to set on the new meeting. Only `$transcript` is writable on create; all other meeting relationships are system-managed.
                autoCreateRecords:
                  type: boolean
                  description: When true, the initial post-create meeting sync may auto-create account and contact records for external attendees.
              required:
              - fields
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingCreateResponse'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '409':
          description: '409'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictError'
        '415':
          description: '415'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedMediaTypeError'
        '422':
          description: '422'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableContentError'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '503':
          description: '503'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableError'
        '504':
          description: '504'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutError'
      tags:
      - Meetings
    get:
      operationId: meeting.list
      summary: List meetings
      description: '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 <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about pagination.


        **[Required scope](/using-the-api/scopes/):** `meetings:read`


        **[Rate limit category](/using-the-api/rate-limits/):** Search'
      security:
      - bearerAuth: []
      parameters:
      - name: Lightfield-Version
        in: header
        required: true
        description: Required API version header. Requests may error without it.
        schema:
          type: string
          enum:
          - '2026-03-01'
          default: '2026-03-01'
        example: '2026-03-01'
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: Number of records to skip for pagination. Defaults to 0.
        allowEmptyValue: true
        allowReserved: true
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 9007199254740991
          description: Maximum number of records to return. Defaults to 25, maximum 25.
        allowEmptyValue: true
        allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingListResponse'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '409':
          description: '409'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictError'
        '415':
          description: '415'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedMediaTypeError'
        '422':
          description: '422'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableContentError'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '503':
          description: '503'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableError'
        '504':
          description: '504'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutError'
      tags:
      - Meetings
  /v1/meetings/{id}:
    post:
      operationId: meeting.update
      summary: Update a meeting
      description: '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 `$account` and `$opportunity` relationships are read-only and are derived from the meeting''s `$contact` attendees and the accounts/opportunities those contacts belong to. The response is privacy-aware and includes a read-only `accessLevel`. See <u>[Uploading meeting transcripts](/using-the-api/uploading-meeting-transcripts/)</u> 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'
      security:
      - bearerAuth: []
      parameters:
      - name: Lightfield-Version
        in: header
        required: true
        description: Required API version header. Requests may error without it.
        schema:
          type: string
          enum:
          - '2026-03-01'
          default: '2026-03-01'
        example: '2026-03-01'
      - name: id
        in: path
        required: true
        schema:
          type: string
          description: Unique identifier of the meeting to update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fields:
                  type: object
                  properties:
                    $privacySetting:
                      anyOf:
                      - enum:
                        - FULL
                        - METADATA
                      - type: 'null'
                      description: The privacy setting for the meeting.
                  required:
                  - $privacySetting
                  additionalProperties: false
                  description: Field values to update. Only `$privacySetting` is writable, and omitted fields are left unchanged.
                relationships:
                  type: object
                  properties:
                    $transcript:
                      type: object
                      properties:
                        replace:
                          type: string
                          description: The file ID to set as the meeting transcript.
                      required:
                      - replace
                      additionalProperties: false
                  required:
                  - $transcript
                  additionalProperties: false
                  description: Relationship operations to apply. Only `$transcript.replace` is supported; removing or clearing `$transcript` is not supported.
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingUpdateResponse'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '409':
          description: '409'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictError'
        '415':
          description: '415'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedMediaTypeError'
        '422':
          description: '422'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableContentError'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '503':
          description: '503'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableError'
        '504':
          description: '504'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutError'
      tags:
      - Meetings
    get:
      operationId: meeting.retrieve
      summary: Retrieve a meeting
      description: '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'
      security:
      - bearerAuth: []
      parameters:
      - name: Lightfield-Version
        in: header
        required: true
        description: Required API version header. Requests may error without it.
        schema:
          type: string
          enum:
          - '2026-03-01'
          default: '2026-03-01'
        example: '2026-03-01'
      - name: id
        in: path
        required: true
        schema:
          type: string
          description: Unique identifier of the meeting to retrieve.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingRetrieveResponse'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: '404'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '409':
          description: '409'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictError'
        '415':
          description: '415'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedMediaTypeError'
        '422':
          description: '422'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableContentError'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsError'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '503':
          description: '503'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableError'
        '504':
          description: '504'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayTimeoutError'
      tags:
      - Meetings
components:
  schemas:
    MeetingUpdateResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the entity.
        createdAt:
          type: string
          description: ISO 8601 timestamp of when the entity was created.
        updatedAt:
          anyOf:
          - type: string
          - type: 'null'
          description: ISO 8601 timestamp of when the entity was last updated, or null.
        httpLink:
          anyOf:
          - type: string
          - type: 'null'
          description: URL to view the entity in the Lightfield web app, or null.
        externalId:
          anyOf:
          - type: string
          - type: 'null'
          description: External identifier for the entity, or null if unset.
        fields:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              valueType:
                enum:
                - ADDRESS
                - CHECKBOX
                - CURRENCY
                - DATETIME
                - EMAIL
                - FULL_NAME
                - MARKDOWN
                - MULTI_SELECT
                - NUMBER
                - SINGLE_SELECT
                - SOCIAL_HANDLE
                - TELEPHONE
                - TEXT
                - URL
                - HTML
                description: The data type of the field.
              value:
                anyOf:
                - type: string
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: number
                - type: boolean
                - type: 'null'
                - type: array
                  items:
                    type: string
                - $ref: '#/components/schemas/Address'
                - $ref: '#/components/schemas/FullName'
                description: The field value, or null if unset.
            required:
            - valueType
            - value
          description: Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
        relationships:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              cardinality:
                type: string
                description: Whether the relationship is `has_one` or `has_many`.
              objectType:
                type: string
                description: The type of the related object (e.g. `account`, `contact`).
              values:
                type: array
                items:
                  type: string
                description: IDs of the related entities.
            required:
            - cardinality
            - objectType
            - values
          description: Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).
        objectType:
          enum:
          - meeting
          description: Always `meeting`.
        accessLevel:
          enum:
          - FULL
          - METADATA
          description: The caller's resolved access level for this meeting.
      required:
      - id
      - createdAt
      - updatedAt
      - httpLink
      - fields
      - relationships
      - objectType
      - accessLevel
      additionalProperties: false
    MeetingCreateResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the entity.
        createdAt:
          type: string
          description: ISO 8601 timestamp of when the entity was created.
        updatedAt:
          anyOf:
          - type: string
          - type: 'null'
          description: ISO 8601 timestamp of when the entity was last updated, or null.
        httpLink:
          anyOf:
          - type: string
          - type: 'null'
          description: URL to view the entity in the Lightfield web app, or null.
        externalId:
          anyOf:
          - type: string
          - type: 'null'
          description: External identifier for the entity, or null if unset.
        fields:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              valueType:
                enum:
                - ADDRESS
                - CHECKBOX
                - CURRENCY
                - DATETIME
                - EMAIL
                - FULL_NAME
                - MARKDOWN
                - MULTI_SELECT
                - NUMBER
                - SINGLE_SELECT
                - SOCIAL_HANDLE
                - TELEPHONE
                - TEXT
                - URL
                - HTML
                description: The data type of the field.
              value:
                anyOf:
                - type: string
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: number
                - type: boolean
                - type: 'null'
                - type: array
                  items:
                    type: string
                - $ref: '#/components/schemas/Address'
                - $ref: '#/components/schemas/FullName'
                description: The field value, or null if unset.
            required:
            - valueType
            - value
          description: Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
        relationships:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              cardinality:
                type: string
                description: Whether the relationship is `has_one` or `has_many`.
              objectType:
                type: string
                description: The type of the related object (e.g. `account`, `contact`).
              values:
                type: array
                items:
                  type: string
                description: IDs of the related entities.
            required:
            - cardinality
            - objectType
            - values
          description: Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).
        objectType:
          enum:
          - meeting
          description: Always `meeting`.
        accessLevel:
          enum:
          - FULL
          - METADATA
          description: The caller's resolved access level for this meeting.
      required:
      - id
      - createdAt
      - updatedAt
      - httpLink
      - fields
      - relationships
      - objectType
      - accessLevel
      additionalProperties: false
    MeetingRetrieveResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the entity.
        createdAt:
          type: string
          description: ISO 8601 timestamp of when the entity was created.
        updatedAt:
          anyOf:
          - type: string
          - type: 'null'
          description: ISO 8601 timestamp of when the entity was last updated, or null.
        httpLink:
          anyOf:
          - type: string
          - type: 'null'
          description: URL to view the entity in the Lightfield web app, or null.
        externalId:
          anyOf:
          - type: string
          - type: 'null'
          description: External identifier for the entity, or null if unset.
        fields:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              valueType:
                enum:
                - ADDRESS
                - CHECKBOX
                - CURRENCY
                - DATETIME
                - EMAIL
                - FULL_NAME
                - MARKDOWN
                - MULTI_SELECT
                - NUMBER
                - SINGLE_SELECT
                - SOCIAL_HANDLE
                - TELEPHONE
                - TEXT
                - URL
                - HTML
                description: The data type of the field.
              value:
                anyOf:
                - type: string
                - type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                - type: number
                - type: boolean
                - type: 'null'
                - type: array
                  items:
                    type: string
                - $ref: '#/components/schemas/Address'
                - $ref: '#/components/schemas/FullName'
                description: The field value, or null if unset.
            required:
            - valueType
            - value
          description: Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
        relationships:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: object
            properties:
              cardinality:
                type: string
                description: Whether the relationship is `has_one` or `has_many`.
              objectType:
                type: string
                description: The type of the related object (e.g. `account`, `contact`).
              values:
                type: array
                items:
                  type: string
                description: IDs of the related entities.
            required:
            - cardinality
            - objectType
            - values
          description: Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).
        objectType:
          enum:
          - meeting
          description: Always `meeting`.
        accessLevel:
          enum:
          - FULL
          - METADATA
          description: The caller's resolved access level for this meeting.
      required:
      - id
      - createdAt
      - updatedAt
      - httpLink
      - fields
      - relationships
      - objectType
      - accessLevel
      additionalProperties: false
    InternalServerError:
      type: object
      properties:
        type:
          const: internal_server_error
        message:
          type: string
          default: Internal Server Error
      required:
      - type
      - message
    GatewayTimeoutError:
      type: object
      properties:
        type:
          const: gateway_timeout
        message:
          type: string
          default: Gateway Timeout
      required:
      - type
      - message
    TooManyRequestsError:
      type: object
      properties:
        type:
          const: too_many_requests
        message:
          type: string
          default: Too Many Requests
      required:
      - type
      - message
    FullName:
      type: object
      properties:
        firstName:
          anyOf:
          - type: string
          - type: 'null'
          description: The contact's first name.
        lastName:
          anyOf:
          - type: string
          - type: 'null'
          description: The contact's last name.
      additionalProperties: false
      title: FullName
    UnsupportedMediaTypeError:
      type: object
      properties:
        type:
          const: unsupported_media_type
        message:
          type: string
          default: Unsupported Media Type
      required:
      - type
      - message
    ForbiddenError:
      type: object
      properties:
        type:
          const: forbidden
        message:
          type: string
          default: Forbidden
      required:
      - type
      - message
    ConflictError:
      type: object
      properties:
        type:
          const: conflict
        message:
          type: string
          default: Conflict
      required:
      - type
      - message
    MeetingListResponse:
      type: object
      properties:
        object:
          type: string
          description: The object type, always `"list"`.
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the entity.
              createdAt:
                type: string
                description: ISO 8601 timestamp of when the entity was created.
              updatedAt:
                anyOf:
                - type: string
                - type: 'null'
                description: ISO 8601 timestamp of when the entity was last updated, or null.
              httpLink:
                anyOf:
                - type: string
                - type: 'null'
                description: URL to view the entity in the Lightfield web app, or null.
              externalId:
                anyOf:
                - type: string
                - type: 'null'
                description: External identifier for the entity, or null if

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightfield/refs/heads/main/openapi/lightfield-meetings-api-openapi.yml