## Definitions

`client.task.definitions(RequestOptionsoptions?): 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 <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for more details.

**[Required scope](/using-the-api/scopes/):** `tasks:read`

**[Rate limit category](/using-the-api/rate-limits/):** Read

### Returns

- `TaskDefinitionsResponse`

  - `fieldDefinitions: Record<string, FieldDefinitions>`

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

    - `description: string | null`

      Description of the field, or null.

    - `label: string`

      Human-readable display name of the field.

    - `typeConfiguration: TypeConfiguration`

      Type-specific configuration (e.g. select options, currency code).

      - `currency?: string`

        ISO 4217 3-letter currency code.

      - `handleService?: "TWITTER" | "LINKEDIN" | "FACEBOOK" | "INSTAGRAM"`

        Social platform associated with this handle field.

        - `"TWITTER"`

        - `"LINKEDIN"`

        - `"FACEBOOK"`

        - `"INSTAGRAM"`

      - `multipleValues?: boolean`

        Whether this field accepts multiple values.

      - `options?: Array<Option>`

        Available options for select fields.

        - `id: string`

          Unique identifier of the select option.

        - `label: string`

          Human-readable display name of the option.

        - `description?: string | null`

          Description of the option, or null.

      - `unique?: boolean`

        Whether values for this field must be unique.

    - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 11 more`

      Data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

    - `id?: string`

      Unique identifier of the field definition.

    - `readOnly?: boolean`

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

  - `objectType: string`

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

  - `relationshipDefinitions: Record<string, RelationshipDefinitions>`

    Map of relationship keys to their definitions.

    - `cardinality: "HAS_ONE" | "HAS_MANY"`

      Whether this is a `has_one` or `has_many` relationship.

      - `"HAS_ONE"`

      - `"HAS_MANY"`

    - `description: string | null`

      Description of the relationship, or null.

    - `label: string`

      Human-readable display name of the relationship.

    - `objectType: string`

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

    - `id?: string`

      Unique identifier of the relationship definition.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const taskDefinitionsResponse = await client.task.definitions();

console.log(taskDefinitionsResponse.fieldDefinitions);
```