## 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"
```