Skip to content

List meetings

client.Meeting.List(ctx, query) (*MeetingListResponse, error)
GET/v1/meetings

Returns a paginated list of meetings. Results are sorted by when the record was created in Lightfield (createdAt), newest first. This is not the meeting start time. 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. 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. They are left out when accessLevel is METADATA, as in the Lightfield app. At METADATA, the response also names no attendee: $title is a neutral “Private meeting”, and $attendeeEmails, $organizerEmail, $manuallyAddedAttendeeEmails, $manuallyRemovedAttendeeEmails and the $contact and $member relationships are left out. A filter on $attendeeEmails matches only meetings the caller can read in full, so it never lists a METADATA meeting. As in the Lightfield app, a meeting is listed only when it is internal-only or linked to an account or an active contact; this applies to every caller, including admins and workspace API keys. Pass status=trashed to list meetings currently in the trash instead of live records. Listing trashed records additionally requires the meetings:restore scope. See List endpoints for more information about pagination.

Required scope: meetings:read

Rate limit category: Search

ParametersExpand Collapse
query MeetingListParams
Limit param.Field[int64]Optional

Maximum number of records to return. Defaults to 25, maximum 25.

minimum1
maximum9007199254740991
Offset param.Field[int64]Optional

Number of records to skip for pagination. Defaults to 0.

minimum0
maximum9007199254740991
Status param.Field[MeetingListParamsStatus]Optional

Which records to return by trash state. Defaults to “active”. Use “trashed” to list records currently in the trash; this additionally requires this resource’s restore scope.

const MeetingListParamsStatusActive MeetingListParamsStatus = "active"
const MeetingListParamsStatusTrashed MeetingListParamsStatus = "trashed"
ReturnsExpand Collapse
type MeetingListResponse struct{…}
Data []MeetingListResponseData

Array of meeting objects for the current page.

ID string

Unique identifier for the entity.

AccessLevel string

The caller’s resolved access level for this meeting.

One of the following:
const MeetingListResponseDataAccessLevelFull MeetingListResponseDataAccessLevel = "FULL"
const MeetingListResponseDataAccessLevelMetadata MeetingListResponseDataAccessLevel = "METADATA"
CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MeetingListResponseDataField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value MeetingListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type MeetingListResponseDataFieldValueArray []string
type MeetingListResponseDataFieldValueAddress struct{…}
City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type MeetingListResponseDataFieldValueFullName struct{…}
FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:
const MeetingListResponseDataFieldValueTypeAddress MeetingListResponseDataFieldValueType = "ADDRESS"
const MeetingListResponseDataFieldValueTypeCheckbox MeetingListResponseDataFieldValueType = "CHECKBOX"
const MeetingListResponseDataFieldValueTypeCurrency MeetingListResponseDataFieldValueType = "CURRENCY"
const MeetingListResponseDataFieldValueTypeDate MeetingListResponseDataFieldValueType = "DATE"
const MeetingListResponseDataFieldValueTypeDatetime MeetingListResponseDataFieldValueType = "DATETIME"
const MeetingListResponseDataFieldValueTypeEmail MeetingListResponseDataFieldValueType = "EMAIL"
const MeetingListResponseDataFieldValueTypeFullName MeetingListResponseDataFieldValueType = "FULL_NAME"
const MeetingListResponseDataFieldValueTypeMarkdown MeetingListResponseDataFieldValueType = "MARKDOWN"
const MeetingListResponseDataFieldValueTypeMultiSelect MeetingListResponseDataFieldValueType = "MULTI_SELECT"
const MeetingListResponseDataFieldValueTypeNumber MeetingListResponseDataFieldValueType = "NUMBER"
const MeetingListResponseDataFieldValueTypeSingleSelect MeetingListResponseDataFieldValueType = "SINGLE_SELECT"
const MeetingListResponseDataFieldValueTypeSocialHandle MeetingListResponseDataFieldValueType = "SOCIAL_HANDLE"
const MeetingListResponseDataFieldValueTypeTelephone MeetingListResponseDataFieldValueType = "TELEPHONE"
const MeetingListResponseDataFieldValueTypeText MeetingListResponseDataFieldValueType = "TEXT"
const MeetingListResponseDataFieldValueTypeURL MeetingListResponseDataFieldValueType = "URL"
const MeetingListResponseDataFieldValueTypeHTML MeetingListResponseDataFieldValueType = "HTML"
ObjectType string

Always meeting.

Relationships map[string, MeetingListResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions MeetingListResponseDataRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination MeetingListResponseDataRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const MeetingListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne MeetingListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const MeetingListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany MeetingListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource MeetingListResponseDataRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const MeetingListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne MeetingListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const MeetingListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany MeetingListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0
maximum9007199254740991

List meetings

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  meetingListResponse, err := client.Meeting.List(context.TODO(), githubcomlightfldlightfieldgo.MeetingListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", meetingListResponse.Data)
}
{
  "data": [
    {
      "id": "id",
      "accessLevel": "FULL",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "objectType": "meeting",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}
Returns Examples
{
  "data": [
    {
      "id": "id",
      "accessLevel": "FULL",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "ADDRESS"
        }
      },
      "httpLink": "httpLink",
      "objectType": "meeting",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}