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

2026-07-21T07:32:44Z

‎Successful Response (200)

Ashley DeBon: /* Get Opportunities */

2026-07-21T07:32:09Z

‎Get Opportunities

Ashley DeBon: Created page with "== Get Opportunities == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities === Purpose === Retrieves a paginated list of opportunities for..."

2026-07-21T07:31:56Z

Created page with "== Get Opportunities == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities === Purpose === Retrieves a paginated list of opportunities for..."

New page

== Get Opportunities ==

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

=== Endpoint ===
/api/opportunities

=== Purpose ===
Retrieves a paginated list of opportunities for the authenticated user’s company, with optional filters for date range, probability, markets/users, type, stage, contact type, and search text. Results include account details, stage/type, value, probability, owner, linked people/accounts, location, and custom fields.

=== HTTP Method ===
GET

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

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

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| page || integer || No || Page number for pagination (default: 1). Page size is 10
|-
| start_date || string || No || Start of date range filter (used with <code>end_date</code>)
|-
| end_date || string || No || End of date range filter (used with <code>start_date</code>)
|-
| pull_by || integer || No || Date field to filter: <code>2</code> = created date; otherwise close date
|-
| start_probability || integer || No || Minimum probability (0–100). Must be numeric between 0 and 100 when provided
|-
| end_probability || integer || No || Maximum probability (0–100). Must be numeric between 0 and 100 when provided
|-
| sort_by || integer || No || Sort by created date: <code>1</code> = ascending, <code>2</code> = descending (default also orders by ID descending)
|-
| markets || string || No || Comma-separated market IDs used to filter opportunity owners
|-
| market_users || string || No || Comma-separated user IDs used to filter opportunity owners
|-
| opportunity_type_id || integer || No || Filter by opportunity type
|-
| stage_id || integer || No || Filter by opportunity stage
|-
| contact_type_id || integer || No || Filter by contact type of the associated account
|-
| search || string || No || Search text applied to opportunity results
|}

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

=== Successful Response (200) ===
Returns a paginated list of opportunities.

{| 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 || Opportunities payload
|-
| firstItemOnPage || integer || Index of the first item on the current page
|-
| lastItemOnPage || integer || Index of the last item on the current page
|-
| hasNextPage || boolean || Whether a next page is available
|-
| hasPreviousPage || boolean || Whether a previous page is available
|-
| isFirstPage || boolean || Whether the current page is the first page
|-
| isLastPage || boolean || Whether the current page is the last page
|-
| next_page_url || string/null || URL of the next page, when available
|-
| prev_page_url || string/null || URL of the previous page, when available
|-
| first_page_url || string || URL of the first page
|-
| last_page_url || string || URL of the last page
|-
| pageCount || integer || Total number of pages
|-
| pageNumber || integer || Current page number
|-
| pageSize || integer || Number of items per page (10)
|-
| totalItemCount || integer || Total number of matching opportunities
|-
| uri || string || Requested resource URI
|}

==== data.opportunities[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| opportunity_id || integer || Unique identifier of the opportunity
|-
| contact_id || integer || Associated contact/account ID
|-
| associated_account_name || string || Company/account name
|-
| contact_type_id || integer/string || Contact type identifier
|-
| contact_type || string || Contact type name
|-
| 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>)
|-
| opportunity_type || string || Opportunity type name
|-
| opportunity_type_id || integer || Opportunity type identifier
|-
| opportunity_sign || string || Currency/sign used for opportunity value
|-
| value || number || Opportunity value
|-
| prob || integer/number || Probability percentage
|-
| derived || number || Derived value (<code>value × probability / 100</code>)
|-
| owner || string || Opportunity owner name
|-
| owner_id || integer || Opportunity owner user ID
|-
| latitude || string/number || Contact latitude
|-
| longitude || string/number || Contact longitude
|-
| linked_contacts || array || People linked to the opportunity (<code>id</code>, <code>name</code>)
|-
| linked_accounts || array || Accounts linked to the opportunity (<code>id</code>, <code>name</code>)
|-
| custom_fields || array || Opportunity custom field values
|-
| note || string || Opportunity notes
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 401 with the first validation error message
|-
| 400 || Bad Request – opportunities could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Invalid <code>start_probability</code> or <code>end_probability</code> (must be numeric between 0 and 100).
* '''400''' – An error occurred while retrieving opportunities (for example, "Error while retrieving the Contact Opportunities").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 07:32, 21 July 2026
Line 1:		Line 1:
−	== Get Opportunities ==	+	== [[Mobile_API]] »Get Opportunities ==

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

@@ Line 61: / Line 61: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Opportunity Details - Revision history

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

Ashley DeBon: /* Get Opportunities */

Ashley DeBon: Created page with "== Get Opportunities == === Base URL === https://apimobile.callproof.com === Endpoint === /api/opportunities === Purpose === Retrieves a paginated list of opportunities for..."