---
title: "Get opportunity field definitions"
method: GET
path: "/v1/opportunities/definitions"
---

# Get opportunity field 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

## Headers

- `Lightfield-Version` '2026-03-01', required

## Response `200`

OK

- OpportunityDefinitionsResponse
  - `objectType` string, required — The object type these definitions belong to (e.g. `account`).
  - `fieldDefinitions` object, required — Map of field keys to their definitions, including both system and custom fields.
  - `relationshipDefinitions` object, required — Map of relationship keys to their definitions.

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `409` — 409
- `415` — 415
- `422` — 422
- `429` — 429
- `500` — 500
- `501` — 501
- `503` — 503
- `504` — 504

## Changes

- **2026-07-28** `93b6c5de5463` — 1 info
  - added the non-success response with the status `501`
- **2026-05-21** `7b3cf2deef52` — 1 warning, 1 info
  - added the new `HTML` enum value to the `fieldDefinitions/additionalProperties/valueType` response property for the response status `200`
  - added the non-success response with the status `504`
- **2026-04-17** `9e026e8daea4` — 1 breaking, 6 info
  - removed 'propertyNames' constraint from the `fieldDefinitions/additionalProperties/typeConfiguration` response property for the status `200`
  - the endpoint scheme security `bearerAuth2` was removed from the API
  - added the optional property `fieldDefinitions/additionalProperties/typeConfiguration/currency` to the response with the `200` status
  - added the optional property `fieldDefinitions/additionalProperties/typeConfiguration/handleService` to the response with the `200` status
  - …3 more
- **2026-03-20** `1870cc51fb17` — 1 info
  - added the optional property `fieldDefinitions/additionalProperties/readOnly` to the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/lightfld/apis/api-reference/changes/v1/opportunities/definitions/get.md)

---

[API](https://skmtc.dev/lightfld/apis/api-reference.md) · [All operations](https://skmtc.dev/lightfld/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightfld/api-reference/revisions/93b6c5de5463/schema)