# Opportunity

## Definitions

**get** `/v1/opportunities/definitions`

Returns the schema for all field and relationship definitions available on opportunities, including both system-defined and custom fields. Useful for understanding the shape of opportunity 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/):** `opportunities:read`

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

### Returns

- `OpportunityDefinitionsResponse = 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.

    - `description: string`

      Description of the field, or null.

    - `label: string`

      Human-readable display name of the field.

    - `typeConfiguration: map[string or number or boolean or 2 more]`

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

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

    - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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: optional string`

      Unique identifier of the field definition.

    - `readOnly: optional 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: map[object { cardinality, description, label, 2 more } ]`

    Map of relationship keys to their definitions.

    - `cardinality: "HAS_ONE" or "HAS_MANY"`

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

      - `"HAS_ONE"`

      - `"HAS_MANY"`

    - `description: string`

      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: optional string`

      Unique identifier of the relationship definition.

### Example

```http
curl https://api.lightfield.app/v1/opportunities/definitions \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY"
```

## Create

**post** `/v1/opportunities`

Creates a new opportunity record. The `$name` and `$stage` fields and the `$account` relationship are required.

After creation, Lightfield automatically generates an opportunity summary in the background. The `$opportunityStatus` field is read-only and cannot be set via the API. The `$task` and `$note` relationships are also read-only — manage them via the `$opportunity` relationship on the task, or the `$account`/`$opportunity` note relationships instead.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `opportunities:create`

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

### Body Parameters

- `fields: object { "$name", "$stage" }  or map[string or number or boolean or 2 more]`

  Field values for the new opportunity. System fields use a `$` prefix (e.g. `$name`, `$stage`); custom attributes use their bare slug. Required: `$name` (string) and `$stage` (option ID or label). Fields of type `SINGLE_SELECT` or `MULTI_SELECT` accept either an option ID or label from the field's `typeConfiguration.options` — call the <u>[definitions endpoint](/api/resources/opportunity/methods/definitions)</u> to discover available fields and options. See <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for value type details.

  - `UnionMember0 = object { "$name", "$stage" }`

    - `"$name": string`

      Display name of the opportunity.

    - `"$stage": string`

      Pipeline stage (`SINGLE_SELECT`). Pass the option ID or label from the field definition.

  - `UnionMember1 = map[string or number or boolean or 2 more]`

    - `UnionMember0 = string`

    - `UnionMember1 = number`

    - `UnionMember2 = boolean`

    - `UnionMember3 = array of string or number or boolean or 2 more`

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of unknown`

      - `UnionMember4 = map[unknown]`

    - `UnionMember4 = map[string or number or boolean or 2 more]`

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of unknown`

      - `UnionMember4 = map[unknown]`

- `relationships: object { "$account", "$champion", "$createdBy", 2 more }  or map[string or array of string]`

  Relationships to set on the new opportunity. System relationships use a `$` prefix (e.g. `$account`, `$owner`); custom relationships use their bare slug. `$account` is required. Each value is a single entity ID or an array of IDs. Call the <u>[definitions endpoint](/api/resources/opportunity/methods/definitions)</u> to list available relationship keys.

  - `UnionMember0 = object { "$account", "$champion", "$createdBy", 2 more }`

    - `"$account": string or array of string`

      ID of the account this opportunity belongs to.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

    - `"$champion": optional string or array of string`

      ID of the contact who is the internal champion.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

    - `"$createdBy": optional string or array of string`

      ID of the user who created this opportunity.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

    - `"$evaluator": optional string or array of string`

      ID of the contact who is the evaluator.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

    - `"$owner": optional string or array of string`

      ID of the user who owns this opportunity.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

  - `UnionMember1 = map[string or array of string]`

    - `UnionMember0 = string`

    - `UnionMember1 = array of string`

### Returns

- `OpportunityCreateResponse = object { id, createdAt, fields, 2 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    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.

    - `value: string or number or boolean or 2 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

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

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    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`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: array of string`

      IDs of the related entities.

### Example

```http
curl https://api.lightfield.app/v1/opportunities \
    -H 'Content-Type: application/json' \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY" \
    -d '{
          "fields": {
            "$name": "$name",
            "$stage": "$stage"
          },
          "relationships": {
            "$account": "string"
          }
        }'
```

## Update

**post** `/v1/opportunities/{id}`

Updates an existing opportunity by ID. Only included fields and relationships are modified.

The `$opportunityStatus` field is read-only and cannot be updated. The `$task` and `$note` relationships are also read-only — manage them via the `$opportunity` relationship on the task, or the `$account`/`$opportunity` note relationships instead.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `opportunities:update`

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

### Path Parameters

- `id: string`

  Unique identifier of the opportunity to update.

### Body Parameters

- `fields: optional object { "$name", "$stage" }  or map[string or number or boolean or 2 more]`

  Field values to update — only provided fields are modified; omitted fields are left unchanged. System fields use a `$` prefix (e.g. `$name`, `$stage`); custom attributes use their bare slug. `SINGLE_SELECT` and `MULTI_SELECT` fields accept an option ID or label — call the <u>[definitions endpoint](/api/resources/opportunity/methods/definitions)</u> for available options. See <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for value type details.

  - `UnionMember0 = object { "$name", "$stage" }`

    - `"$name": optional string`

      Display name of the opportunity.

    - `"$stage": optional string`

      Pipeline stage (`SINGLE_SELECT`). Pass the option ID or label from the field definition.

  - `UnionMember1 = map[string or number or boolean or 2 more]`

    - `UnionMember0 = string`

    - `UnionMember1 = number`

    - `UnionMember2 = boolean`

    - `UnionMember3 = array of string or number or boolean or 2 more`

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of unknown`

      - `UnionMember4 = map[unknown]`

    - `UnionMember4 = map[string or number or boolean or 2 more]`

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of unknown`

      - `UnionMember4 = map[unknown]`

- `relationships: optional object { "$champion", "$evaluator", "$owner" }  or map[object { add, remove, replace } ]`

  Relationship operations to apply. System relationships use a `$` prefix (e.g. `$owner`, `$champion`). Each value is an operation object with `add`, `remove`, or `replace`.

  - `UnionMember0 = object { "$champion", "$evaluator", "$owner" }`

    - `"$champion": optional object { add, remove, replace }`

      Operation to modify the internal champion.

      - `add: optional string or array of string`

        Entity ID(s) to add to the relationship.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

      - `remove: optional string or array of string`

        Entity ID(s) to remove from the relationship.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

      - `replace: optional string or array of string`

        Entity ID(s) to set as the entire relationship, replacing all existing associations.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

    - `"$evaluator": optional object { add, remove, replace }`

      Operation to modify the evaluator.

      - `add: optional string or array of string`

        Entity ID(s) to add to the relationship.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

      - `remove: optional string or array of string`

        Entity ID(s) to remove from the relationship.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

      - `replace: optional string or array of string`

        Entity ID(s) to set as the entire relationship, replacing all existing associations.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

    - `"$owner": optional object { add, remove, replace }`

      Operation to modify the opportunity owner.

      - `add: optional string or array of string`

        Entity ID(s) to add to the relationship.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

      - `remove: optional string or array of string`

        Entity ID(s) to remove from the relationship.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

      - `replace: optional string or array of string`

        Entity ID(s) to set as the entire relationship, replacing all existing associations.

        - `UnionMember0 = string`

        - `UnionMember1 = array of string`

  - `UnionMember1 = map[object { add, remove, replace } ]`

    - `add: optional string or array of string`

      Entity ID(s) to add to the relationship.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

    - `remove: optional string or array of string`

      Entity ID(s) to remove from the relationship.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

    - `replace: optional string or array of string`

      Entity ID(s) to set as the entire relationship, replacing all existing associations.

      - `UnionMember0 = string`

      - `UnionMember1 = array of string`

### Returns

- `OpportunityUpdateResponse = object { id, createdAt, fields, 2 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    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.

    - `value: string or number or boolean or 2 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

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

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    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`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: array of string`

      IDs of the related entities.

### Example

```http
curl https://api.lightfield.app/v1/opportunities/$ID \
    -H 'Content-Type: application/json' \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY" \
    -d '{}'
```

## Retrieve

**get** `/v1/opportunities/{id}`

Retrieves a single opportunity by its ID.

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

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

### Path Parameters

- `id: string`

  Unique identifier of the opportunity to retrieve.

### Returns

- `OpportunityRetrieveResponse = object { id, createdAt, fields, 2 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    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.

    - `value: string or number or boolean or 2 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

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

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    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`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: array of string`

      IDs of the related entities.

### Example

```http
curl https://api.lightfield.app/v1/opportunities/$ID \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY"
```

## List

**get** `/v1/opportunities`

Returns a paginated list of opportunities. Use `offset` and `limit` to paginate through results. See <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about pagination.

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

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

### Query Parameters

- `limit: optional number`

  Maximum number of records to return. Defaults to 25, maximum 25.

- `offset: optional number`

  Number of records to skip for pagination. Defaults to 0.

### Returns

- `OpportunityListResponse = object { data, object, totalCount }`

  - `data: array of object { id, createdAt, fields, 2 more }`

    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[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.

      - `value: string or number or boolean or 2 more`

        The field value, or null if unset.

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of string or number or boolean or 2 more`

          - `UnionMember0 = string`

          - `UnionMember1 = number`

          - `UnionMember2 = boolean`

          - `UnionMember3 = array of unknown`

          - `UnionMember4 = map[unknown]`

        - `UnionMember4 = map[string or number or boolean or 2 more]`

          - `UnionMember0 = string`

          - `UnionMember1 = number`

          - `UnionMember2 = boolean`

          - `UnionMember3 = array of unknown`

          - `UnionMember4 = map[unknown]`

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

        The data type of the field.

        - `"ADDRESS"`

        - `"CHECKBOX"`

        - `"CURRENCY"`

        - `"DATETIME"`

        - `"EMAIL"`

        - `"FULL_NAME"`

        - `"MARKDOWN"`

        - `"MULTI_SELECT"`

        - `"NUMBER"`

        - `"SINGLE_SELECT"`

        - `"SOCIAL_HANDLE"`

        - `"TELEPHONE"`

        - `"TEXT"`

        - `"URL"`

    - `httpLink: string`

      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`).

      - `cardinality: string`

        Whether the relationship is `has_one` or `has_many`.

      - `objectType: string`

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

      - `values: array of string`

        IDs of the related entities.

  - `object: string`

    The object type, always `"list"`.

  - `totalCount: number`

    Total number of entities matching the query.

### Example

```http
curl https://api.lightfield.app/v1/opportunities \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY"
```

## Domain Types

### Opportunity Create Response

- `OpportunityCreateResponse = object { id, createdAt, fields, 2 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    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.

    - `value: string or number or boolean or 2 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

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

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    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`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: array of string`

      IDs of the related entities.

### Opportunity Definitions Response

- `OpportunityDefinitionsResponse = 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.

    - `description: string`

      Description of the field, or null.

    - `label: string`

      Human-readable display name of the field.

    - `typeConfiguration: map[string or number or boolean or 2 more]`

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

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

    - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 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: optional string`

      Unique identifier of the field definition.

    - `readOnly: optional 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: map[object { cardinality, description, label, 2 more } ]`

    Map of relationship keys to their definitions.

    - `cardinality: "HAS_ONE" or "HAS_MANY"`

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

      - `"HAS_ONE"`

      - `"HAS_MANY"`

    - `description: string`

      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: optional string`

      Unique identifier of the relationship definition.

### Opportunity List Response

- `OpportunityListResponse = object { data, object, totalCount }`

  - `data: array of object { id, createdAt, fields, 2 more }`

    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[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.

      - `value: string or number or boolean or 2 more`

        The field value, or null if unset.

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of string or number or boolean or 2 more`

          - `UnionMember0 = string`

          - `UnionMember1 = number`

          - `UnionMember2 = boolean`

          - `UnionMember3 = array of unknown`

          - `UnionMember4 = map[unknown]`

        - `UnionMember4 = map[string or number or boolean or 2 more]`

          - `UnionMember0 = string`

          - `UnionMember1 = number`

          - `UnionMember2 = boolean`

          - `UnionMember3 = array of unknown`

          - `UnionMember4 = map[unknown]`

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

        The data type of the field.

        - `"ADDRESS"`

        - `"CHECKBOX"`

        - `"CURRENCY"`

        - `"DATETIME"`

        - `"EMAIL"`

        - `"FULL_NAME"`

        - `"MARKDOWN"`

        - `"MULTI_SELECT"`

        - `"NUMBER"`

        - `"SINGLE_SELECT"`

        - `"SOCIAL_HANDLE"`

        - `"TELEPHONE"`

        - `"TEXT"`

        - `"URL"`

    - `httpLink: string`

      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`).

      - `cardinality: string`

        Whether the relationship is `has_one` or `has_many`.

      - `objectType: string`

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

      - `values: array of string`

        IDs of the related entities.

  - `object: string`

    The object type, always `"list"`.

  - `totalCount: number`

    Total number of entities matching the query.

### Opportunity Retrieve Response

- `OpportunityRetrieveResponse = object { id, createdAt, fields, 2 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    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.

    - `value: string or number or boolean or 2 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

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

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    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`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: array of string`

      IDs of the related entities.

### Opportunity Update Response

- `OpportunityUpdateResponse = object { id, createdAt, fields, 2 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    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.

    - `value: string or number or boolean or 2 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string or number or boolean or 2 more`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

      - `UnionMember4 = map[string or number or boolean or 2 more]`

        - `UnionMember0 = string`

        - `UnionMember1 = number`

        - `UnionMember2 = boolean`

        - `UnionMember3 = array of unknown`

        - `UnionMember4 = map[unknown]`

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

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    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`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

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

    - `values: array of string`

      IDs of the related entities.