--- title: "Get opportunity" method: GET path: "/crm/opportunities/{id}" tags: ["Opportunities"] --- # Get opportunity `GET /crm/opportunities/{id}` Get opportunity ## Path parameters - `id` string, required ## Query parameters - `raw` boolean - `fields` string, nullable ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string ## Response `200` Opportunity - GetOpportunityResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` Opportunity, required - `id` string — A unique identifier for the opportunity. - `title` string, required — The title or name of the opportunity. - `primary_contact_id` string, nullable — The unique identifier of the primary contact associated with the opportunity. - `description` string, nullable — A description of the opportunity. - `type` string, nullable — The type of the opportunity - `monetary_amount` number, nullable — The monetary value associated with the opportunity - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `win_probability` number, nullable — The probability of winning the opportunity, expressed as a percentage. - `expected_revenue` number, nullable — The expected revenue from the opportunity - `close_date` string, date, nullable — The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet. - `loss_reason_id` string, nullable — The unique identifier of the reason why the opportunity was lost. - `loss_reason` string, nullable — The reason why the opportunity was lost. - `won_reason_id` string, nullable — The unique identifier of the reason why the opportunity was won. - `won_reason` string, nullable — The reason why the opportunity was won. - `pipeline_id` string, nullable — The unique identifier of the pipeline associated with the opportunity - `pipeline_stage_id` string, nullable — The unique identifier of the stage in the pipeline associated with the opportunity. - `source_id` string, nullable — The unique identifier of the source of the opportunity. - `lead_id` string, nullable — The unique identifier of the lead associated with the opportunity. - `lead_source` string, nullable — The source of the lead associated with the opportunity. - `contact_id` string, nullable — The unique identifier of the contact associated with the opportunity. - `contact_ids` string[] — An array of unique identifiers of all contacts associated with the opportunity. - `company_id` string, nullable — The unique identifier of the company associated with the opportunity. - `company_name` string, nullable — The name of the company associated with the opportunity. - `owner_id` string, nullable — The unique identifier of the user who owns the opportunity. - `priority` string, nullable — The priority level of the opportunity. - `status` string, nullable — The current status of the opportunity. - `status_id` string, nullable — The unique identifier of the current status of the opportunity. - `tags` string[], nullable - `interaction_count` number, nullable — The number of interactions with the opportunity. - `custom_fields` CustomField[] - union - object - `id` string, nullable, required — Unique identifier for the custom field. - `name` string, nullable — Name of the custom field. - `description` string, nullable — More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - object - `id` string, nullable — Unique identifier for the custom field. - `name` string, nullable, required — Name of the custom field. - `description` string, nullable — More information about the custom field - `value` union - string, nullable - number, nullable - boolean, nullable - object, nullable - union[] - … - `stage_last_changed_at` string, date-time, nullable — The date and time when the stage of the opportunity was last changed. - `last_activity_at` string, nullable — The date and time of the last activity associated with the opportunity. - `deleted` boolean — Indicates whether the opportunity has been deleted. - `date_stage_changed` string, date-time, nullable — The date and time when the stage of the opportunity was last changed. - `date_last_contacted` string, date-time, nullable — The date and time when the opportunity was last contacted. - `date_lead_created` string, date-time, nullable — The date and time when the lead associated with the opportunity was created. - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here. - `updated_by` string, nullable — The unique identifier of the user who last updated the opportunity. - `created_by` string, nullable — The unique identifier of the user who created the opportunity. - `updated_at` string, date-time, nullable — The date and time when the opportunity was last updated. - `created_at` string, date-time, nullable — The date and time when the opportunity was created. - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` string, required — Identifier for the service to which this pass_through should be applied. - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` object — Simple object allowing any properties for direct extension. - `extend_paths` object[] — Array of objects for structured data modifications via paths. - `path` string, required — JSONPath string specifying where to apply the value. - `value` unknown, required - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.net/apideck-libraries/apis/crm-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/crm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/crm-api/versions/171537af6722/schema)