{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference Accounts Opportunities API",
    "version": "0.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Opportunities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get opportunity field definitions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/opportunities/definitions",
            "headers": [
              {
                "name": "Lightfield-Version",
                "value": "2026-03-01"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "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.\n\n**[Required scope](/using-the-api/scopes/):** `opportunities:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read"
        },
        {
          "info": {
            "name": "List opportunities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/opportunities",
            "headers": [
              {
                "name": "Lightfield-Version",
                "value": "2026-03-01"
              }
            ],
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a paginated list of opportunities. Use `offset` and `limit` to paginate through results, and `$field` query parameters to filter. See <u>[List endpoints](/using-the-api/list-endpoints/)</u> for more information about <u>[pagination](/using-the-api/list-endpoints/#pagination)</u> and <u>[filtering](/using-the-api/list-endpoints/#filtering)</u>.\n\n**[Required scope](/using-the-api/scopes/):** `opportunities:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Search"
        },
        {
          "info": {
            "name": "Create an opportunity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/opportunities",
            "headers": [
              {
                "name": "Lightfield-Version",
                "value": "2026-03-01"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a new opportunity record. The `$name` and `$stage` fields and the `$account` relationship are required.\n\nAfter 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`, `$note`, and `$meeting` relationships are also read-only — manage them via the `$opportunity` relationship on the task, the `$account`/`$opportunity` note relationships, or via the meeting's `$contact` atte"
        },
        {
          "info": {
            "name": "Retrieve an opportunity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/opportunities/:id",
            "headers": [
              {
                "name": "Lightfield-Version",
                "value": "2026-03-01"
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves a single opportunity by its ID.\n\n**[Required scope](/using-the-api/scopes/):** `opportunities:read`\n\n**[Rate limit category](/using-the-api/rate-limits/):** Read"
        },
        {
          "info": {
            "name": "Update an opportunity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/opportunities/:id",
            "headers": [
              {
                "name": "Lightfield-Version",
                "value": "2026-03-01"
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates an existing opportunity by ID. Only included fields and relationships are modified.\n\nThe `$opportunityStatus` field is read-only and cannot be updated. The `$task`, `$note`, and `$meeting` relationships are also read-only — manage them via the `$opportunity` relationship on the task, the `$account`/`$opportunity` note relationships, or via the meeting's `$contact` attendees that belong to this opportunity's account.\n\nSupports idempotency via the `Idempotency-Key` header.\n\n**[Required sco"
        }
      ]
    }
  ],
  "bundled": true
}