API Reference
Libraries
API Overview
Account
Accounts represent companies or organizations in Lightfield. Each account can have contacts, opportunities, tasks, and notes associated with it.
Get account field definitions
GET/v1/accounts/definitions
Create an account
POST/v1/accounts
Update an account
POST/v1/accounts/{id}
Retrieve an account
GET/v1/accounts/{id}
List accounts
GET/v1/accounts
Contact
Contacts represent individual people in Lightfield. Contacts can be associated with one or more accounts.
Get contact field definitions
GET/v1/contacts/definitions
Create a contact
POST/v1/contacts
Update a contact
POST/v1/contacts/{id}
Retrieve a contact
GET/v1/contacts/{id}
List contacts
GET/v1/contacts
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
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