Skip to content

Retrieve a meeting

client.Meeting.Get(ctx, id) (*MeetingRetrieveResponse, error)
GET/v1/meetings/{id}

Retrieves a single meeting by its ID. $transcript is the file ID of the canonical transcript. $transcripts lists the file ID of every transcript on the meeting. $note lists the note IDs attached to the meeting. 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. Meeting fields and transcript visibility are redacted based on the caller-specific privacy resolution, and the response includes a read-only accessLevel.

Required scope: meetings:read

Rate limit category: Read

ParametersExpand Collapse
id string

Unique identifier of the meeting to retrieve.

ReturnsExpand Collapse
type MeetingRetrieveResponse struct{…}
ID string

Unique identifier for the entity.

AccessLevel MeetingRetrieveResponseAccessLevel

The caller’s resolved access level for this meeting.

One of the following:
const MeetingRetrieveResponseAccessLevelFull MeetingRetrieveResponseAccessLevel = "FULL"
const MeetingRetrieveResponseAccessLevelMetadata MeetingRetrieveResponseAccessLevel = "METADATA"
CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, MeetingRetrieveResponseField]

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

Value MeetingRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type MeetingRetrieveResponseFieldValueArray []string
type MeetingRetrieveResponseFieldValueAddress 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 MeetingRetrieveResponseFieldValueFullName 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 MeetingRetrieveResponseFieldValueTypeAddress MeetingRetrieveResponseFieldValueType = "ADDRESS"
const MeetingRetrieveResponseFieldValueTypeCheckbox MeetingRetrieveResponseFieldValueType = "CHECKBOX"
const MeetingRetrieveResponseFieldValueTypeCurrency MeetingRetrieveResponseFieldValueType = "CURRENCY"
const MeetingRetrieveResponseFieldValueTypeDate MeetingRetrieveResponseFieldValueType = "DATE"
const MeetingRetrieveResponseFieldValueTypeDatetime MeetingRetrieveResponseFieldValueType = "DATETIME"
const MeetingRetrieveResponseFieldValueTypeEmail MeetingRetrieveResponseFieldValueType = "EMAIL"
const MeetingRetrieveResponseFieldValueTypeFullName MeetingRetrieveResponseFieldValueType = "FULL_NAME"
const MeetingRetrieveResponseFieldValueTypeMarkdown MeetingRetrieveResponseFieldValueType = "MARKDOWN"
const MeetingRetrieveResponseFieldValueTypeMultiSelect MeetingRetrieveResponseFieldValueType = "MULTI_SELECT"
const MeetingRetrieveResponseFieldValueTypeNumber MeetingRetrieveResponseFieldValueType = "NUMBER"
const MeetingRetrieveResponseFieldValueTypeSingleSelect MeetingRetrieveResponseFieldValueType = "SINGLE_SELECT"
const MeetingRetrieveResponseFieldValueTypeSocialHandle MeetingRetrieveResponseFieldValueType = "SOCIAL_HANDLE"
const MeetingRetrieveResponseFieldValueTypeTelephone MeetingRetrieveResponseFieldValueType = "TELEPHONE"
const MeetingRetrieveResponseFieldValueTypeText MeetingRetrieveResponseFieldValueType = "TEXT"
const MeetingRetrieveResponseFieldValueTypeURL MeetingRetrieveResponseFieldValueType = "URL"
const MeetingRetrieveResponseFieldValueTypeHTML MeetingRetrieveResponseFieldValueType = "HTML"
ObjectType MeetingRetrieveResponseObjectType

Always meeting.

Relationships map[string, MeetingRetrieveResponseRelationship]

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 MeetingRetrieveResponseRelationshipDirectionsOptional

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 MeetingRetrieveResponseRelationshipDirectionsAsDestination

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 MeetingRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne MeetingRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const MeetingRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany MeetingRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource MeetingRetrieveResponseRelationshipDirectionsAsSource

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 MeetingRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne MeetingRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const MeetingRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany MeetingRetrieveResponseRelationshipDirectionsAsSourceCardinality = "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.

Retrieve a meeting

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"),
  )
  meetingRetrieveResponse, err := client.Meeting.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", meetingRetrieveResponse.ID)
}
{
  "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"
}
Returns Examples
{
  "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"
}