API guides

Use these guides to call the endpoints in the API reference. Each endpoint walkthrough explains when to use an operation, the request to send, how to use its response and what to do if it fails. Related endpoints can share one walkthrough, such as creating a file upload and completing it.

For setup and working in the Lightfield app, use the Product help center. The reference lists complete request parameters and response schemas; these guides show how to use them.

Make your first request

Choose the interface that fits your task:

Interface	Start here	Use it for
HTTP	HTTP quickstart	Calling REST endpoints from your own stack
Python	Python quickstart	Python services and scripts
TypeScript	TypeScript quickstart	JavaScript and TypeScript integrations
Go	Go quickstart	Go services and tools
CLI	CLI quickstart	Terminal tasks and shell scripts
MCP	MCP quickstart	Giving an AI client access to Lightfield

Choose an operation

Your task	Walkthrough	What you finish with
Keep CRM records in sync	Create, update and restore records	A saved record ID and a verified change.
Understand custom fields	Fields and relationships	The correct field keys, value shapes and linked IDs.
Read a dataset	List and filter records	Every accessible result, including pages filtered by permissions.
Combine duplicate records	Merge records	One retained ID and a checked merge result.
Maintain a named audience	Lists and membership	A list with the intended accounts, contacts or opportunities.
Assign work	Find members	The correct workspace member ID for an assignee or reviewer.
Fill missing information	Enrich a record	A completed run and inspected field values or suggestions.
Upload an attachment	Upload files	A completed file ready for its intended use.
Send, draft or log email	Emails and attachments	A provider send/draft result or a logged historical email.
Record a past meeting	Manage meeting records	A manual meeting with verified attendees and access.
Work with transcripts	Retrieve or upload a transcript	The readable primary source, or an attached uploaded source.
Give the agent a document	Upload knowledge files	A staged upload, with the separate Knowledge step explained.
Read synced conversations	Messages and channels	Messages and attachments handled with their access limits.
Run outbound outreach	Sequences and senders	A tested, published sequence and correctly configured senders.
Follow background work	Check a workflow run	A status tied to the original run ID.

Handle authentication, errors and retries

Start with authentication and scopes. Handle errors, respect rate limits, and use idempotency where supported when retrying writes.

Each walkthrough links to the exact endpoint reference. Product availability, permissions and UI setup stay in Help; a guide links to those prerequisites rather than repeating their procedures.