Retrieve Specific Opportunity Details - Revision history

Ashley DeBon: /* cURL Example for Android */

2026-07-21T08:03:23Z

‎cURL Example for Android

Ashley DeBon: /* cURL Example for iOS */

2026-07-21T08:03:09Z

‎cURL Example for iOS

Ashley DeBon: /* Successful Response (200) */

2026-07-21T08:02:50Z

‎Successful Response (200)

Ashley DeBon: /* Successful Response (200) */

2026-07-21T08:01:31Z

‎Successful Response (200)

Ashley DeBon: /* Get Specific Opportunity */

2026-07-21T08:00:38Z

‎Get Specific Opportunity

Ashley DeBon: Created page with "== Get Specific Opportunity == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities/{id} === Purpose === Retrieves a single opportunity by I..."

2026-07-21T08:00:26Z

Created page with "== Get Specific Opportunity == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities/{id} === Purpose === Retrieves a single opportunity by I..."

New page

== Get Specific Opportunity ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/opportunities/{id}

=== Purpose ===
Retrieves a single opportunity by ID, including stage, type, value, probability, owner, linked people/accounts, notes, and custom field values.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| id || integer || Yes || Unique identifier of the opportunity
|}

==== Query Parameters ====
None.

==== Request Body ====
None.

=== Successful Response (200) ===
Returns the opportunity details.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| data || object || Opportunity payload
|-
| uri || string || Requested resource URI
|}

==== data.opportunities ====
{| class="wikitable"
! Field !! Type !! Description
|-
| opportunity_id || integer || Unique identifier of the opportunity
|-
| contact_id || integer || Primary contact associated with the opportunity
|-
| name || string || Opportunity name
|-
| stage || string || Opportunity stage name
|-
| stage_id || integer || Opportunity stage identifier
|-
| closing || string || Close date (format: <code>m-d-Y</code>), or empty when not set
|-
| opportunity_type || string || Opportunity type name
|-
| opportunity_type_id || integer || Opportunity type identifier
|-
| opportunity_sign || string || Currency/value sign used for the opportunity
|-
| value || number || Opportunity value
|-
| prob || number || Probability percentage
|-
| derived || number || Derived value (<code>value * probability / 100</code>)
|-
| owner || string/object || Opportunity owner details
|-
| owner_id || integer || Owner user identifier
|-
| custom_fields || array || Opportunity custom fields and values
|-
| linked_contacts || array || People linked to the opportunity
|-
| linked_accounts || array || Accounts/contacts linked to the opportunity
|-
| note || string || Opportunity notes
|}

==== data.opportunities.linked_contacts[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| id || integer || Personnel identifier
|-
| name || string || Full name of the linked person
|}

==== data.opportunities.linked_accounts[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| id || integer || Linked contact/account identifier
|-
| name || string || Linked account/company name
|}

==== data.opportunities.custom_fields[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| id || integer || Custom field identifier
|-
| name || string || Field display name
|-
| position || integer || Field display order
|-
| required || boolean || Whether the field is required
|-
| custom_field_id || integer || Custom field identifier
|-
| custom_field_inner_id || integer || Related/inner custom field identifier
|-
| custom_field_type_id || integer || Field type identifier
|-
| custom_field_table_id || integer || Custom field table identifier
|-
| custom_field_option || array/object || Available options for the field
|-
| custom_field_option_default_id || string || Selected option ID(s), when applicable
|-
| value || string || Stored field value (may be a full image URL for image fields)
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – the opportunity could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – An error occurred while retrieving the opportunity (for example, "Error while retrieving the Contact Opportunities").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 08:03, 21 July 2026
Line 43:		Line 43:

	=== cURL Example for iOS ===		=== cURL Example for iOS ===
−
−	~~<pre> curl --location 'https://apimobile.callproof.com/api/opportunities/YOUR_OPPORTUNITY_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>~~
−
−	~~=== cURL Example for Android ===~~

	<pre> curl --location 'https://apimobile.callproof.com/api/opportunities/YOUR_OPPORTUNITY_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>		<pre> curl --location 'https://apimobile.callproof.com/api/opportunities/YOUR_OPPORTUNITY_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>

← Older revision		Revision as of 08:03, 21 July 2026
Line 47:		Line 47:

	=== cURL Example for Android ===		=== cURL Example for Android ===
−
−	~~<pre> curl --location 'https://apimobile.callproof.com/api/opportunities/YOUR_OPPORTUNITY_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>~~
−
−	~~=== cURL Example for iOS ===~~

	<pre> curl --location 'https://apimobile.callproof.com/api/opportunities/YOUR_OPPORTUNITY_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>		<pre> curl --location 'https://apimobile.callproof.com/api/opportunities/YOUR_OPPORTUNITY_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>

@@ Line 37: / Line 37: @@
 ==== Request Body ====
 None.
 === cURL Example for Android ===

← Older revision		Revision as of 08:00, 21 July 2026
Line 1:		Line 1:
−	== Get Specific Opportunity ==	+	== [[Mobile_API]] »Get Specific Opportunity ==

	=== Base URL ===		=== Base URL ===