Skip to content

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
client.Task.Definitions(ctx, query) (*TaskDefinitionsResponse, error)
GET/v1/tasks/definitions
Create a task
client.Task.New(ctx, body) (*TaskCreateResponse, error)
POST/v1/tasks
Update a task
client.Task.Update(ctx, id, body) (*TaskUpdateResponse, error)
POST/v1/tasks/{id}
Retrieve a task
client.Task.Get(ctx, id) (*TaskRetrieveResponse, error)
GET/v1/tasks/{id}
List tasks
client.Task.List(ctx, query) (*TaskListResponse, error)
GET/v1/tasks
Delete a task
client.Task.Delete(ctx, id, body) (*TaskDeleteResponse, error)
DELETE/v1/tasks/{id}
Restore a task
client.Task.Restore(ctx, id, body) (*TaskRestoreResponse, error)
POST/v1/tasks/{id}/restore
ModelsExpand Collapse
type TaskCreateResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskCreateResponseField]

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

Value TaskCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type TaskCreateResponseFieldValueArray []string
type TaskCreateResponseFieldValueAddress 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 TaskCreateResponseFieldValueFullName 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 TaskCreateResponseFieldValueTypeAddress TaskCreateResponseFieldValueType = "ADDRESS"
const TaskCreateResponseFieldValueTypeCheckbox TaskCreateResponseFieldValueType = "CHECKBOX"
const TaskCreateResponseFieldValueTypeCurrency TaskCreateResponseFieldValueType = "CURRENCY"
const TaskCreateResponseFieldValueTypeDate TaskCreateResponseFieldValueType = "DATE"
const TaskCreateResponseFieldValueTypeDatetime TaskCreateResponseFieldValueType = "DATETIME"
const TaskCreateResponseFieldValueTypeEmail TaskCreateResponseFieldValueType = "EMAIL"
const TaskCreateResponseFieldValueTypeFullName TaskCreateResponseFieldValueType = "FULL_NAME"
const TaskCreateResponseFieldValueTypeMarkdown TaskCreateResponseFieldValueType = "MARKDOWN"
const TaskCreateResponseFieldValueTypeMultiSelect TaskCreateResponseFieldValueType = "MULTI_SELECT"
const TaskCreateResponseFieldValueTypeNumber TaskCreateResponseFieldValueType = "NUMBER"
const TaskCreateResponseFieldValueTypeSingleSelect TaskCreateResponseFieldValueType = "SINGLE_SELECT"
const TaskCreateResponseFieldValueTypeSocialHandle TaskCreateResponseFieldValueType = "SOCIAL_HANDLE"
const TaskCreateResponseFieldValueTypeTelephone TaskCreateResponseFieldValueType = "TELEPHONE"
const TaskCreateResponseFieldValueTypeText TaskCreateResponseFieldValueType = "TEXT"
const TaskCreateResponseFieldValueTypeURL TaskCreateResponseFieldValueType = "URL"
const TaskCreateResponseFieldValueTypeHTML TaskCreateResponseFieldValueType = "HTML"
Relationships map[string, TaskCreateResponseRelationship]

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 TaskCreateResponseRelationshipDirectionsOptional

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 TaskCreateResponseRelationshipDirectionsAsDestination

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 TaskCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne TaskCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany TaskCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource TaskCreateResponseRelationshipDirectionsAsSource

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 TaskCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne TaskCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const TaskCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany TaskCreateResponseRelationshipDirectionsAsSourceCardinality = "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.

type TaskDefinitionsResponse struct{…}
FieldDefinitions map[string, TaskDefinitionsResponseFieldDefinition]

Map of field keys to their definitions, including both system and custom fields.

Archived bool

Whether the field definition is archived.

ArchivedAt Time

When the field definition was archived, or null if active.

formatdate-time
Description string

Description of the field, or null.

Label string

Human-readable display name of the field.

TypeConfiguration TaskDefinitionsResponseFieldDefinitionTypeConfiguration

Type-specific configuration (e.g. select options, currency code). A key the field type does not support is absent; a supported key with nothing set is null.

Currency stringOptional

ISO 4217 3-letter currency code. Present on CURRENCY fields, absent on every other type.

DecimalPlaces int64Optional

Number of decimal places values carry, or null when none is set. Present on NUMBER and CURRENCY fields, absent on every other type.

minimum-9007199254740991
maximum9007199254740991
HandleService stringOptional

Social platform associated with this handle field, or null when none is set. Present on SOCIAL_HANDLE fields, absent on every other type.

One of the following:
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram TaskDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"
MultipleValues boolOptional

Whether this field accepts multiple values. Present on EMAIL, TELEPHONE and URL fields, absent on every other type.

Options []TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options. Always present on SINGLE_SELECT and MULTI_SELECT fields, as an empty list when there are none. Absent on every other type.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Category stringOptional

Lifecycle group of the option, in-progress (ACTIVE) or done (COMPLETED), or null when none is set. Absent on selects whose options are not grouped.

One of the following:
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryActive TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "ACTIVE"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryCompleted TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "COMPLETED"
Color stringOptional

Color the option is displayed in, GRAY when none was chosen. Absent on selects whose options take no color.

One of the following:
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorRed TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "RED"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorOrange TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "ORANGE"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorYellow TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "YELLOW"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorLime TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "LIME"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGreen TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GREEN"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorBlue TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "BLUE"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorIndigo TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "INDIGO"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorPurple TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "PURPLE"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorCopper TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "COPPER"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGray TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GRAY"
Description stringOptional

Description of the option, or null.

ForecastPercentage float64Optional

Forecast weighting of the option from 0 to 100, or null when none is set. Absent on selects whose options take no forecast.

Icon stringOptional

Icon the option is displayed with, or null when none is set. Present only on $stage.

One of the following:
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconBacklog TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "BACKLOG"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconQualification TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "QUALIFICATION"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconDiscovery TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "DISCOVERY"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconActive TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "ACTIVE"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconNegotiation TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "NEGOTIATION"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedWon TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_WON"
const TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedLost TaskDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_LOST"
ParentID stringOptional

For a dependent select, the ID of the option in the parent field named by typeConfiguration.parentFieldKey that owns this option. Absent for ordinary selects.

ParentFieldKey stringOptional

For a dependent select, the field key whose selected option determines which of this field’s options apply. Absent for ordinary selects.

Unique boolOptional

Whether values for this field must be unique, or null when not set. Present on EMAIL, TELEPHONE, URL and SOCIAL_HANDLE fields, absent on every other type.

ValueType string

Data type of the field.

One of the following:
const TaskDefinitionsResponseFieldDefinitionValueTypeAddress TaskDefinitionsResponseFieldDefinitionValueType = "ADDRESS"
const TaskDefinitionsResponseFieldDefinitionValueTypeCheckbox TaskDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"
const TaskDefinitionsResponseFieldDefinitionValueTypeCurrency TaskDefinitionsResponseFieldDefinitionValueType = "CURRENCY"
const TaskDefinitionsResponseFieldDefinitionValueTypeDate TaskDefinitionsResponseFieldDefinitionValueType = "DATE"
const TaskDefinitionsResponseFieldDefinitionValueTypeDatetime TaskDefinitionsResponseFieldDefinitionValueType = "DATETIME"
const TaskDefinitionsResponseFieldDefinitionValueTypeEmail TaskDefinitionsResponseFieldDefinitionValueType = "EMAIL"
const TaskDefinitionsResponseFieldDefinitionValueTypeFullName TaskDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"
const TaskDefinitionsResponseFieldDefinitionValueTypeMarkdown TaskDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"
const TaskDefinitionsResponseFieldDefinitionValueTypeMultiSelect TaskDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"
const TaskDefinitionsResponseFieldDefinitionValueTypeNumber TaskDefinitionsResponseFieldDefinitionValueType = "NUMBER"
const TaskDefinitionsResponseFieldDefinitionValueTypeSingleSelect TaskDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"
const TaskDefinitionsResponseFieldDefinitionValueTypeSocialHandle TaskDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"
const TaskDefinitionsResponseFieldDefinitionValueTypeTelephone TaskDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"
const TaskDefinitionsResponseFieldDefinitionValueTypeText TaskDefinitionsResponseFieldDefinitionValueType = "TEXT"
const TaskDefinitionsResponseFieldDefinitionValueTypeURL TaskDefinitionsResponseFieldDefinitionValueType = "URL"
const TaskDefinitionsResponseFieldDefinitionValueTypeHTML TaskDefinitionsResponseFieldDefinitionValueType = "HTML"
ID stringOptional

Unique identifier of the field definition.

AIFillable stringOptional

Whether AI fills this field automatically (ON), only suggests values (SUGGEST), or leaves it alone (OFF). Absent on built-in fields that have no id.

One of the following:
const TaskDefinitionsResponseFieldDefinitionAIFillableOn TaskDefinitionsResponseFieldDefinitionAIFillable = "ON"
const TaskDefinitionsResponseFieldDefinitionAIFillableOff TaskDefinitionsResponseFieldDefinitionAIFillable = "OFF"
const TaskDefinitionsResponseFieldDefinitionAIFillableSuggest TaskDefinitionsResponseFieldDefinitionAIFillable = "SUGGEST"
AIFillablePrompt stringOptional

Instructions AI follows when filling this field, or null when none are set. Absent on built-in fields that have no id.

Formula stringOptional

Formula a calculated field evaluates, with fields and relationships referenced by key. Null for fields that are not calculated. Absent on built-in fields that have no id.

ReadOnly boolOptional

true for fields that are not writable via the API (e.g. AI-generated summaries, calculated fields). false or absent for writable fields.

ValueSource stringOptional

Whether values are entered (MANUAL) or calculated from a formula (COMPUTED). Absent on built-in fields that have no id.

One of the following:
const TaskDefinitionsResponseFieldDefinitionValueSourceManual TaskDefinitionsResponseFieldDefinitionValueSource = "MANUAL"
const TaskDefinitionsResponseFieldDefinitionValueSourceComputed TaskDefinitionsResponseFieldDefinitionValueSource = "COMPUTED"
ObjectType string

The object type these definitions belong to (e.g. account).

RelationshipDefinitions map[string, TaskDefinitionsResponseRelationshipDefinition]

Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.

Archived bool

Whether the relationship definition is archived.

ArchivedAt Time

When the relationship definition was archived, or null if active.

formatdate-time
Cardinality string

Whether this is a has_one or has_many relationship.

One of the following:
const TaskDefinitionsResponseRelationshipDefinitionCardinalityHasOne TaskDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"
const TaskDefinitionsResponseRelationshipDefinitionCardinalityHasMany TaskDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"
Description string

Description of the relationship, or null.

Label string

Human-readable display name of the relationship, as it reads from this object type.

ObjectType string

The type of the related object (e.g. account, contact).

ID stringOptional

Unique identifier of the relationship definition.

Directions TaskDefinitionsResponseRelationshipDefinitionDirectionsOptional

Directional metadata for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination TaskDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

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 TaskDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne TaskDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany TaskDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

AsSource TaskDefinitionsResponseRelationshipDefinitionDirectionsAsSource

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 TaskDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne TaskDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"
const TaskDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany TaskDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

GroupKey stringOptional

Key of the relationship group this relationship belongs to, as listed under relationshipGroupDefinitions. Absent when the relationship is not in a group.

Inverse TaskDefinitionsResponseRelationshipDefinitionInverseOptional

How the same relationship reads from the related object type.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const TaskDefinitionsResponseRelationshipDefinitionInverseCardinalityHasOne TaskDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_ONE"
const TaskDefinitionsResponseRelationshipDefinitionInverseCardinalityHasMany TaskDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

RelationshipGroupDefinitions map[string, TaskDefinitionsResponseRelationshipGroupDefinition]

Map of relationship group keys to their definitions. A group collects relationships between the same two object types, such as the roles a contact can hold on an opportunity. Relationships name their group with groupKey.

ID string

Unique identifier of the relationship group.

Archived bool

Whether the relationship group is archived.

ArchivedAt Time

When the relationship group was archived, or null if active.

formatdate-time
Inverse TaskDefinitionsResponseRelationshipGroupDefinitionInverse

How the same group reads from the related object type.

Label string

Human-readable display name of the group, as it reads from the related object type.

Label string

Human-readable display name of the group, as it reads from this object type.

ObjectType string

The type of the related object every relationship in the group points to.

type TaskDeleteResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskDeleteResponseField]

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

Value TaskDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type TaskDeleteResponseFieldValueArray []string
type TaskDeleteResponseFieldValueAddress 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 TaskDeleteResponseFieldValueFullName 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 TaskDeleteResponseFieldValueTypeAddress TaskDeleteResponseFieldValueType = "ADDRESS"
const TaskDeleteResponseFieldValueTypeCheckbox TaskDeleteResponseFieldValueType = "CHECKBOX"
const TaskDeleteResponseFieldValueTypeCurrency TaskDeleteResponseFieldValueType = "CURRENCY"
const TaskDeleteResponseFieldValueTypeDate TaskDeleteResponseFieldValueType = "DATE"
const TaskDeleteResponseFieldValueTypeDatetime TaskDeleteResponseFieldValueType = "DATETIME"
const TaskDeleteResponseFieldValueTypeEmail TaskDeleteResponseFieldValueType = "EMAIL"
const TaskDeleteResponseFieldValueTypeFullName TaskDeleteResponseFieldValueType = "FULL_NAME"
const TaskDeleteResponseFieldValueTypeMarkdown TaskDeleteResponseFieldValueType = "MARKDOWN"
const TaskDeleteResponseFieldValueTypeMultiSelect TaskDeleteResponseFieldValueType = "MULTI_SELECT"
const TaskDeleteResponseFieldValueTypeNumber TaskDeleteResponseFieldValueType = "NUMBER"
const TaskDeleteResponseFieldValueTypeSingleSelect TaskDeleteResponseFieldValueType = "SINGLE_SELECT"
const TaskDeleteResponseFieldValueTypeSocialHandle TaskDeleteResponseFieldValueType = "SOCIAL_HANDLE"
const TaskDeleteResponseFieldValueTypeTelephone TaskDeleteResponseFieldValueType = "TELEPHONE"
const TaskDeleteResponseFieldValueTypeText TaskDeleteResponseFieldValueType = "TEXT"
const TaskDeleteResponseFieldValueTypeURL TaskDeleteResponseFieldValueType = "URL"
const TaskDeleteResponseFieldValueTypeHTML TaskDeleteResponseFieldValueType = "HTML"
Relationships map[string, TaskDeleteResponseRelationship]

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 TaskDeleteResponseRelationshipDirectionsOptional

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 TaskDeleteResponseRelationshipDirectionsAsDestination

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 TaskDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne TaskDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany TaskDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource TaskDeleteResponseRelationshipDirectionsAsSource

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 TaskDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne TaskDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const TaskDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany TaskDeleteResponseRelationshipDirectionsAsSourceCardinality = "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.

type TaskListResponse struct{…}
Data []TaskListResponseData

Array of entity objects for the current page.

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskListResponseDataField]

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

Value TaskListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type TaskListResponseDataFieldValueArray []string
type TaskListResponseDataFieldValueAddress 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 TaskListResponseDataFieldValueFullName 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 TaskListResponseDataFieldValueTypeAddress TaskListResponseDataFieldValueType = "ADDRESS"
const TaskListResponseDataFieldValueTypeCheckbox TaskListResponseDataFieldValueType = "CHECKBOX"
const TaskListResponseDataFieldValueTypeCurrency TaskListResponseDataFieldValueType = "CURRENCY"
const TaskListResponseDataFieldValueTypeDate TaskListResponseDataFieldValueType = "DATE"
const TaskListResponseDataFieldValueTypeDatetime TaskListResponseDataFieldValueType = "DATETIME"
const TaskListResponseDataFieldValueTypeEmail TaskListResponseDataFieldValueType = "EMAIL"
const TaskListResponseDataFieldValueTypeFullName TaskListResponseDataFieldValueType = "FULL_NAME"
const TaskListResponseDataFieldValueTypeMarkdown TaskListResponseDataFieldValueType = "MARKDOWN"
const TaskListResponseDataFieldValueTypeMultiSelect TaskListResponseDataFieldValueType = "MULTI_SELECT"
const TaskListResponseDataFieldValueTypeNumber TaskListResponseDataFieldValueType = "NUMBER"
const TaskListResponseDataFieldValueTypeSingleSelect TaskListResponseDataFieldValueType = "SINGLE_SELECT"
const TaskListResponseDataFieldValueTypeSocialHandle TaskListResponseDataFieldValueType = "SOCIAL_HANDLE"
const TaskListResponseDataFieldValueTypeTelephone TaskListResponseDataFieldValueType = "TELEPHONE"
const TaskListResponseDataFieldValueTypeText TaskListResponseDataFieldValueType = "TEXT"
const TaskListResponseDataFieldValueTypeURL TaskListResponseDataFieldValueType = "URL"
const TaskListResponseDataFieldValueTypeHTML TaskListResponseDataFieldValueType = "HTML"
Relationships map[string, TaskListResponseDataRelationship]

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 TaskListResponseDataRelationshipDirectionsOptional

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 TaskListResponseDataRelationshipDirectionsAsDestination

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 TaskListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne TaskListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany TaskListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource TaskListResponseDataRelationshipDirectionsAsSource

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 TaskListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne TaskListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const TaskListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany TaskListResponseDataRelationshipDirectionsAsSourceCardinality = "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.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0
maximum9007199254740991
type TaskRestoreResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskRestoreResponseField]

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

Value TaskRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type TaskRestoreResponseFieldValueArray []string
type TaskRestoreResponseFieldValueAddress 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 TaskRestoreResponseFieldValueFullName 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 TaskRestoreResponseFieldValueTypeAddress TaskRestoreResponseFieldValueType = "ADDRESS"
const TaskRestoreResponseFieldValueTypeCheckbox TaskRestoreResponseFieldValueType = "CHECKBOX"
const TaskRestoreResponseFieldValueTypeCurrency TaskRestoreResponseFieldValueType = "CURRENCY"
const TaskRestoreResponseFieldValueTypeDate TaskRestoreResponseFieldValueType = "DATE"
const TaskRestoreResponseFieldValueTypeDatetime TaskRestoreResponseFieldValueType = "DATETIME"
const TaskRestoreResponseFieldValueTypeEmail TaskRestoreResponseFieldValueType = "EMAIL"
const TaskRestoreResponseFieldValueTypeFullName TaskRestoreResponseFieldValueType = "FULL_NAME"
const TaskRestoreResponseFieldValueTypeMarkdown TaskRestoreResponseFieldValueType = "MARKDOWN"
const TaskRestoreResponseFieldValueTypeMultiSelect TaskRestoreResponseFieldValueType = "MULTI_SELECT"
const TaskRestoreResponseFieldValueTypeNumber TaskRestoreResponseFieldValueType = "NUMBER"
const TaskRestoreResponseFieldValueTypeSingleSelect TaskRestoreResponseFieldValueType = "SINGLE_SELECT"
const TaskRestoreResponseFieldValueTypeSocialHandle TaskRestoreResponseFieldValueType = "SOCIAL_HANDLE"
const TaskRestoreResponseFieldValueTypeTelephone TaskRestoreResponseFieldValueType = "TELEPHONE"
const TaskRestoreResponseFieldValueTypeText TaskRestoreResponseFieldValueType = "TEXT"
const TaskRestoreResponseFieldValueTypeURL TaskRestoreResponseFieldValueType = "URL"
const TaskRestoreResponseFieldValueTypeHTML TaskRestoreResponseFieldValueType = "HTML"
Relationships map[string, TaskRestoreResponseRelationship]

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 TaskRestoreResponseRelationshipDirectionsOptional

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 TaskRestoreResponseRelationshipDirectionsAsDestination

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 TaskRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne TaskRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany TaskRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource TaskRestoreResponseRelationshipDirectionsAsSource

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 TaskRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne TaskRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const TaskRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany TaskRestoreResponseRelationshipDirectionsAsSourceCardinality = "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.

type TaskRetrieveResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskRetrieveResponseField]

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

Value TaskRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type TaskRetrieveResponseFieldValueArray []string
type TaskRetrieveResponseFieldValueAddress 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 TaskRetrieveResponseFieldValueFullName 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 TaskRetrieveResponseFieldValueTypeAddress TaskRetrieveResponseFieldValueType = "ADDRESS"
const TaskRetrieveResponseFieldValueTypeCheckbox TaskRetrieveResponseFieldValueType = "CHECKBOX"
const TaskRetrieveResponseFieldValueTypeCurrency TaskRetrieveResponseFieldValueType = "CURRENCY"
const TaskRetrieveResponseFieldValueTypeDate TaskRetrieveResponseFieldValueType = "DATE"
const TaskRetrieveResponseFieldValueTypeDatetime TaskRetrieveResponseFieldValueType = "DATETIME"
const TaskRetrieveResponseFieldValueTypeEmail TaskRetrieveResponseFieldValueType = "EMAIL"
const TaskRetrieveResponseFieldValueTypeFullName TaskRetrieveResponseFieldValueType = "FULL_NAME"
const TaskRetrieveResponseFieldValueTypeMarkdown TaskRetrieveResponseFieldValueType = "MARKDOWN"
const TaskRetrieveResponseFieldValueTypeMultiSelect TaskRetrieveResponseFieldValueType = "MULTI_SELECT"
const TaskRetrieveResponseFieldValueTypeNumber TaskRetrieveResponseFieldValueType = "NUMBER"
const TaskRetrieveResponseFieldValueTypeSingleSelect TaskRetrieveResponseFieldValueType = "SINGLE_SELECT"
const TaskRetrieveResponseFieldValueTypeSocialHandle TaskRetrieveResponseFieldValueType = "SOCIAL_HANDLE"
const TaskRetrieveResponseFieldValueTypeTelephone TaskRetrieveResponseFieldValueType = "TELEPHONE"
const TaskRetrieveResponseFieldValueTypeText TaskRetrieveResponseFieldValueType = "TEXT"
const TaskRetrieveResponseFieldValueTypeURL TaskRetrieveResponseFieldValueType = "URL"
const TaskRetrieveResponseFieldValueTypeHTML TaskRetrieveResponseFieldValueType = "HTML"
Relationships map[string, TaskRetrieveResponseRelationship]

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 TaskRetrieveResponseRelationshipDirectionsOptional

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 TaskRetrieveResponseRelationshipDirectionsAsDestination

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 TaskRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne TaskRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany TaskRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource TaskRetrieveResponseRelationshipDirectionsAsSource

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 TaskRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne TaskRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const TaskRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany TaskRetrieveResponseRelationshipDirectionsAsSourceCardinality = "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.

type TaskUpdateResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskUpdateResponseField]

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

Value TaskUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type TaskUpdateResponseFieldValueArray []string
type TaskUpdateResponseFieldValueAddress 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 TaskUpdateResponseFieldValueFullName 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 TaskUpdateResponseFieldValueTypeAddress TaskUpdateResponseFieldValueType = "ADDRESS"
const TaskUpdateResponseFieldValueTypeCheckbox TaskUpdateResponseFieldValueType = "CHECKBOX"
const TaskUpdateResponseFieldValueTypeCurrency TaskUpdateResponseFieldValueType = "CURRENCY"
const TaskUpdateResponseFieldValueTypeDate TaskUpdateResponseFieldValueType = "DATE"
const TaskUpdateResponseFieldValueTypeDatetime TaskUpdateResponseFieldValueType = "DATETIME"
const TaskUpdateResponseFieldValueTypeEmail TaskUpdateResponseFieldValueType = "EMAIL"
const TaskUpdateResponseFieldValueTypeFullName TaskUpdateResponseFieldValueType = "FULL_NAME"
const TaskUpdateResponseFieldValueTypeMarkdown TaskUpdateResponseFieldValueType = "MARKDOWN"
const TaskUpdateResponseFieldValueTypeMultiSelect TaskUpdateResponseFieldValueType = "MULTI_SELECT"
const TaskUpdateResponseFieldValueTypeNumber TaskUpdateResponseFieldValueType = "NUMBER"
const TaskUpdateResponseFieldValueTypeSingleSelect TaskUpdateResponseFieldValueType = "SINGLE_SELECT"
const TaskUpdateResponseFieldValueTypeSocialHandle TaskUpdateResponseFieldValueType = "SOCIAL_HANDLE"
const TaskUpdateResponseFieldValueTypeTelephone TaskUpdateResponseFieldValueType = "TELEPHONE"
const TaskUpdateResponseFieldValueTypeText TaskUpdateResponseFieldValueType = "TEXT"
const TaskUpdateResponseFieldValueTypeURL TaskUpdateResponseFieldValueType = "URL"
const TaskUpdateResponseFieldValueTypeHTML TaskUpdateResponseFieldValueType = "HTML"
Relationships map[string, TaskUpdateResponseRelationship]

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 TaskUpdateResponseRelationshipDirectionsOptional

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 TaskUpdateResponseRelationshipDirectionsAsDestination

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 TaskUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne TaskUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const TaskUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany TaskUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource TaskUpdateResponseRelationshipDirectionsAsSource

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 TaskUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne TaskUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const TaskUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany TaskUpdateResponseRelationshipDirectionsAsSourceCardinality = "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.