v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Lead & Opportunity

Opportunities.get

Returns Opportunity with given id

get/entities/Opportunities/{id}

Path parameters

idstring uuid required

ID of Opportunity to retrieve

Response

Opportunity data

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "active_quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "closing_date": "2019-01-01",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "last_ai_buying_center_applied": "2019-01-01T00:00:00",
    "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_currency_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_price_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_account_email": "string",
    "quick_account_name": "string",
    "quick_account_phone": "string",
    "quick_contact_name": "string",
    "quick_email": "string",
    "quick_phone": "string",
    "ranking": 1,
    "reason_of_close_description": "string",
    "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "table_name": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "value": {
      "currency_id": "01234567-abcd-dcba-ffff-000000000000"
    },
    "status": 1,
    "qualify_date": "2019-01-01T00:00:00",
    "won_date": "2019-01-01T00:00:00",
    "lost_date": "2019-01-01T00:00:00",
    "days_in_step": 1,
    "formatted_name": "string",
    "modified_by_user": "2019-01-01T00:00:00"
  }
}