API Reference

Libraries

TypeScript

0.0.1

npm install lightfield

Read Docs

Python

0.0.1

pip install lightfield

Read Docs

0.9.0

go get -u 'github.com/Lightfld/lightfield-go@v0.9.0'

Read Docs

CLI tool

0.6.0

brew install Lightfld/lightfield/lightfield

Read Docs

API Overview

Auth

Auth helper to validate the current token and describe the access it grants. This endpoint is currently only available for API keys.

Account

Accounts represent companies or organizations in Lightfield. Each account can have contacts, opportunities, tasks, and notes associated with it.

Contact

Contacts represent individual people in Lightfield. Contacts can be associated with one or more accounts.

List

Lists are curated collections of accounts, contacts, or opportunities in Lightfield. Each list contains entities of a single type.

Meeting

Meetings represent synced or manually created interactions in Lightfield. Read responses are privacy-aware and may be redacted based on the caller. For transcript uploads and attachment flows, see Uploading meeting transcripts.

Create a meeting

POST/v1/meetings

Update a meeting

POST/v1/meetings/{id}

Retrieve a meeting

GET/v1/meetings/{id}

List meetings

GET/v1/meetings

Delete a meeting

DELETE/v1/meetings/{id}

Note

Notes represent free-form text records in Lightfield. Each note can be associated with zero or more accounts, opportunities, and contacts.

Get note field definitions

GET/v1/notes/definitions

Create a note

POST/v1/notes

Update a note

POST/v1/notes/{id}

Retrieve a note

GET/v1/notes/{id}

List notes

GET/v1/notes

Delete a note

DELETE/v1/notes/{id}

Opportunity

Opportunities represent potential deals or sales in Lightfield. Each opportunity belongs to an account and can have tasks and notes associated with it.

Get opportunity field definitions

GET/v1/opportunities/definitions

Create an opportunity

POST/v1/opportunities

Update an opportunity

POST/v1/opportunities/{id}

Retrieve an opportunity

GET/v1/opportunities/{id}

List opportunities

GET/v1/opportunities

Delete an opportunity

DELETE/v1/opportunities/{id}

Task

Tasks represent action items in Lightfield. Each task belongs to an account, is assigned to a member, and can optionally be associated with an opportunity.

Get task field definitions

GET/v1/tasks/definitions

Create a task

POST/v1/tasks

Update a task

POST/v1/tasks/{id}

Retrieve a task

GET/v1/tasks/{id}

List tasks

GET/v1/tasks

Delete a task

DELETE/v1/tasks/{id}

Member

Members represent users in your Lightfield workspace. Members can own accounts and opportunities, and are referenced in relationships like $owner and $createdBy.

Retrieve a member

GET/v1/members/{id}

List members

GET/v1/members

Workflow Run

Workflow runs represent executions of automated workflows.

Get workflow run status

GET/v1/workflowRun/{runId}/status

File

Files are used to upload documents via presigned URLs. After uploading and completing a file, link it to resources through their own APIs (e.g. attach a transcript to a meeting). See File uploads for the full upload flow and supported purposes. For meeting transcript attachments, see Uploading meeting transcripts.

Create a file upload session

POST/v1/files

Complete a file upload

POST/v1/files/{id}/complete

Retrieve a file

GET/v1/files/{id}

List files

GET/v1/files

Get a file download URL

GET/v1/files/{id}/url

Cancel a file upload

POST/v1/files/{id}/cancel

Object

Custom objects and relationships are available on Pro and Growth plans. Records can be fetched and manipulated via these endpoints, and definitions can be fetched to discover the available custom object types in the system.

Email

Emails represent messages synced from connected email accounts in Lightfield. Read responses are privacy-aware and may be redacted based on the caller.