Skip to content

Get task field definitions

task.definitions(TaskDefinitionsParams**kwargs) -> TaskDefinitionsResponse
GET/v1/tasks/definitions

Returns the schema for the field and relationship definitions available on tasks. Useful for understanding the shape of task data before creating or updating records. See Fields and relationships for more details.

Required scope: tasks:read

Rate limit category: Read

ParametersExpand Collapse
include_archived: Optional[bool]

Include archived field and relationship definitions. Defaults to false.

ReturnsExpand Collapse
class TaskDefinitionsResponse: …
field_definitions: Dict[str, FieldDefinitions]

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

archived: bool

Whether the field definition is archived.

archived_at: Optional[datetime]

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

formatdate-time
description: Optional[str]

Description of the field, or null.

label: str

Human-readable display name of the field.

type_configuration: FieldDefinitionsTypeConfiguration

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: Optional[str]

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

decimal_places: Optional[int]

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
handle_service: Optional[Literal["TWITTER", "LINKEDIN", "FACEBOOK", "INSTAGRAM"]]

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:
"TWITTER"
"LINKEDIN"
"FACEBOOK"
"INSTAGRAM"
multiple_values: Optional[bool]

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

options: Optional[List[FieldDefinitionsTypeConfigurationOption]]

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: str

Unique identifier of the select option.

label: str

Human-readable display name of the option.

category: Optional[Literal["ACTIVE", "COMPLETED"]]

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:
"ACTIVE"
"COMPLETED"
color: Optional[Literal["RED", "ORANGE", "YELLOW", 7 more]]

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

One of the following:
"RED"
"ORANGE"
"YELLOW"
"LIME"
"GREEN"
"BLUE"
"INDIGO"
"PURPLE"
"COPPER"
"GRAY"
description: Optional[str]

Description of the option, or null.

forecast_percentage: Optional[float]

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

icon: Optional[Literal["BACKLOG", "QUALIFICATION", "DISCOVERY", 4 more]]

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

One of the following:
"BACKLOG"
"QUALIFICATION"
"DISCOVERY"
"ACTIVE"
"NEGOTIATION"
"CLOSED_WON"
"CLOSED_LOST"
parent_id: Optional[str]

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.

parent_field_key: Optional[str]

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

unique: Optional[bool]

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.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 13 more]

Data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATE"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
"HTML"
id: Optional[str]

Unique identifier of the field definition.

ai_fillable: Optional[Literal["ON", "OFF", "SUGGEST"]]

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:
"ON"
"OFF"
"SUGGEST"
ai_fillable_prompt: Optional[str]

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

formula: Optional[str]

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.

read_only: Optional[bool]

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

value_source: Optional[Literal["MANUAL", "COMPUTED"]]

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

One of the following:
"MANUAL"
"COMPUTED"
object_type: str

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

relationship_definitions: Dict[str, RelationshipDefinitions]

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.

archived_at: Optional[datetime]

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

formatdate-time
cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this is a has_one or has_many relationship.

One of the following:
"HAS_ONE"
"HAS_MANY"
description: Optional[str]

Description of the relationship, or null.

label: str

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

object_type: str

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

id: Optional[str]

Unique identifier of the relationship definition.

directions: Optional[RelationshipDefinitionsDirections]

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

as_destination: RelationshipDefinitionsDirectionsAsDestination

The current record is the destination (incoming) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
"HAS_ONE"
"HAS_MANY"
label: str

Human-readable display name for this endpoint direction.

as_source: RelationshipDefinitionsDirectionsAsSource

The current record is the source (outgoing) endpoint.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
"HAS_ONE"
"HAS_MANY"
label: str

Human-readable display name for this endpoint direction.

group_key: Optional[str]

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

inverse: Optional[RelationshipDefinitionsInverse]

How the same relationship reads from the related object type.

cardinality: Literal["HAS_ONE", "HAS_MANY"]

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
"HAS_ONE"
"HAS_MANY"
label: str

Human-readable display name for this endpoint direction.

relationship_group_definitions: Dict[str, RelationshipGroupDefinitions]

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: str

Unique identifier of the relationship group.

archived: bool

Whether the relationship group is archived.

archived_at: Optional[datetime]

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

formatdate-time
inverse: RelationshipGroupDefinitionsInverse

How the same group reads from the related object type.

label: str

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

label: str

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

object_type: str

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

Get task field definitions

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
task_definitions_response = client.task.definitions()
print(task_definitions_response.field_definitions)
{
  "fieldDefinitions": {
    "foo": {
      "archived": true,
      "archivedAt": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "label": "label",
      "typeConfiguration": {
        "currency": "currency",
        "decimalPlaces": -9007199254740991,
        "handleService": "TWITTER",
        "multipleValues": true,
        "options": [
          {
            "id": "id",
            "label": "label",
            "category": "ACTIVE",
            "color": "RED",
            "description": "description",
            "forecastPercentage": 0,
            "icon": "BACKLOG",
            "parentId": "parentId"
          }
        ],
        "parentFieldKey": "parentFieldKey",
        "unique": true
      },
      "valueType": "ADDRESS",
      "id": "id",
      "aiFillable": "ON",
      "aiFillablePrompt": "aiFillablePrompt",
      "formula": "formula",
      "readOnly": true,
      "valueSource": "MANUAL"
    }
  },
  "objectType": "objectType",
  "relationshipDefinitions": {
    "foo": {
      "archived": true,
      "archivedAt": "2019-12-27T18:11:19.117Z",
      "cardinality": "HAS_ONE",
      "description": "description",
      "label": "label",
      "objectType": "objectType",
      "id": "id",
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "label": "label"
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "label": "label"
        }
      },
      "groupKey": "groupKey",
      "inverse": {
        "cardinality": "HAS_ONE",
        "label": "label"
      }
    }
  },
  "relationshipGroupDefinitions": {
    "foo": {
      "id": "id",
      "archived": true,
      "archivedAt": "2019-12-27T18:11:19.117Z",
      "inverse": {
        "label": "label"
      },
      "label": "label",
      "objectType": "objectType"
    }
  }
}
Returns Examples
{
  "fieldDefinitions": {
    "foo": {
      "archived": true,
      "archivedAt": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "label": "label",
      "typeConfiguration": {
        "currency": "currency",
        "decimalPlaces": -9007199254740991,
        "handleService": "TWITTER",
        "multipleValues": true,
        "options": [
          {
            "id": "id",
            "label": "label",
            "category": "ACTIVE",
            "color": "RED",
            "description": "description",
            "forecastPercentage": 0,
            "icon": "BACKLOG",
            "parentId": "parentId"
          }
        ],
        "parentFieldKey": "parentFieldKey",
        "unique": true
      },
      "valueType": "ADDRESS",
      "id": "id",
      "aiFillable": "ON",
      "aiFillablePrompt": "aiFillablePrompt",
      "formula": "formula",
      "readOnly": true,
      "valueSource": "MANUAL"
    }
  },
  "objectType": "objectType",
  "relationshipDefinitions": {
    "foo": {
      "archived": true,
      "archivedAt": "2019-12-27T18:11:19.117Z",
      "cardinality": "HAS_ONE",
      "description": "description",
      "label": "label",
      "objectType": "objectType",
      "id": "id",
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "label": "label"
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "label": "label"
        }
      },
      "groupKey": "groupKey",
      "inverse": {
        "cardinality": "HAS_ONE",
        "label": "label"
      }
    }
  },
  "relationshipGroupDefinitions": {
    "foo": {
      "id": "id",
      "archived": true,
      "archivedAt": "2019-12-27T18:11:19.117Z",
      "inverse": {
        "label": "label"
      },
      "label": "label",
      "objectType": "objectType"
    }
  }
}