List meetings

client.Meeting.List(ctx, query) (*MeetingListResponse, error)

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 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

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 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"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

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).

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.

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"
          ]
        }
      },
      "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"
          ]
        }
      },
      "updatedAt": "updatedAt",
      "externalId": "externalId"
    }
  ],
  "object": "object",
  "totalCount": 0
}