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
Create a task
Update a task
Retrieve a task
List tasks
ModelsExpand Collapse
TaskCreateResponse = object { id, createdAt, fields, 4 more }
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
value: string or number or boolean or 3 moreThe field value, or null if unset.
The field value, or null if unset.
Address = object { city, country, latitude, 5 more }
City name.
2-letter ISO 3166-1 alpha-2 country code.
Latitude coordinate.
Longitude coordinate.
Postal or ZIP code.
State or province.
Street address line 1.
Street address line 2.
FullName = object { firstName, lastName }
The contact's first name.
The contact's last name.
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
ISO 8601 timestamp of when the entity was last updated, or null.
External identifier for the entity, or null if unset.
TaskDefinitionsResponse = object { fieldDefinitions, objectType, relationshipDefinitions }
fieldDefinitions: map[object { description, label, typeConfiguration, 3 more } ]Map of field keys to their definitions, including both system and custom fields.
Map of field keys to their definitions, including both system and custom fields.
Description of the field, or null.
Human-readable display name of the field.
typeConfiguration: object { currency, handleService, multipleValues, 2 more } Type-specific configuration (e.g. select options, currency code).
Type-specific configuration (e.g. select options, currency code).
ISO 4217 3-letter currency code.
handleService: optional "TWITTER" or "LINKEDIN" or "FACEBOOK" or "INSTAGRAM"Social platform associated with this handle field.
Social platform associated with this handle field.
Whether this field accepts multiple values.
options: optional array of object { id, label, description } Available options for select fields.
Available options for select fields.
Unique identifier of the select option.
Human-readable display name of the option.
Description of the option, or null.
Whether values for this field must be unique.
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreData type of the field.
Data type of the field.
Unique identifier of the field definition.
true for fields that are not writable via the API (e.g. AI-generated summaries). false or absent for writable fields.
The object type these definitions belong to (e.g. account).
relationshipDefinitions: map[object { cardinality, description, label, 2 more } ]Map of relationship keys to their definitions.
Map of relationship keys to their definitions.
cardinality: "HAS_ONE" or "HAS_MANY"Whether this is a has_one or has_many relationship.
Whether this is a has_one or has_many relationship.
Description of the relationship, or null.
Human-readable display name of the relationship.
The type of the related object (e.g. account, contact).
Unique identifier of the relationship definition.
TaskListResponse = object { data, object, totalCount }
data: array of object { id, createdAt, fields, 4 more } Array of entity objects for the current page.
Array of entity objects for the current page.
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
value: string or number or boolean or 3 moreThe field value, or null if unset.
The field value, or null if unset.
Address = object { city, country, latitude, 5 more }
City name.
2-letter ISO 3166-1 alpha-2 country code.
Latitude coordinate.
Longitude coordinate.
Postal or ZIP code.
State or province.
Street address line 1.
Street address line 2.
FullName = object { firstName, lastName }
The contact's first name.
The contact's last name.
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
ISO 8601 timestamp of when the entity was last updated, or null.
External identifier for the entity, or null if unset.
The object type, always "list".
Total number of entities matching the query.
TaskRetrieveResponse = object { id, createdAt, fields, 4 more }
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
value: string or number or boolean or 3 moreThe field value, or null if unset.
The field value, or null if unset.
Address = object { city, country, latitude, 5 more }
City name.
2-letter ISO 3166-1 alpha-2 country code.
Latitude coordinate.
Longitude coordinate.
Postal or ZIP code.
State or province.
Street address line 1.
Street address line 2.
FullName = object { firstName, lastName }
The contact's first name.
The contact's last name.
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
ISO 8601 timestamp of when the entity was last updated, or null.
External identifier for the entity, or null if unset.
TaskUpdateResponse = object { id, createdAt, fields, 4 more }
Unique identifier for the entity.
ISO 8601 timestamp of when the entity was created.
fields: map[object { value, valueType } ]Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.
value: string or number or boolean or 3 moreThe field value, or null if unset.
The field value, or null if unset.
Address = object { city, country, latitude, 5 more }
City name.
2-letter ISO 3166-1 alpha-2 country code.
Latitude coordinate.
Longitude coordinate.
Postal or ZIP code.
State or province.
Street address line 1.
Street address line 2.
FullName = object { firstName, lastName }
The contact's first name.
The contact's last name.
valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 moreThe data type of the field.
The data type of the field.
URL to view the entity in the Lightfield web app, or null.
relationships: map[object { cardinality, objectType, values } ]Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).
Whether the relationship is has_one or has_many.
The type of the related object (e.g. account, contact).
IDs of the related entities.
ISO 8601 timestamp of when the entity was last updated, or null.
External identifier for the entity, or null if unset.