Retrieve the Opportunity Stage Details
Contents
Mobile_API »Get Opportunity Stages
Base URL
https://apimobile.callproof.com
Endpoint
/api/opportunities-stage
Purpose
Retrieves the opportunity stages configured for the authenticated user’s company, ordered by position.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/opportunities-stage' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/opportunities-stage' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the company’s opportunity stages.
| 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 stage payload |
| uri | string | Requested resource URI |
data.opportunity_stage[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the opportunity stage |
| name | string | Stage display name |
| probability | number | Win probability associated with the stage |
| lock | boolean | Whether the stage is locked |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – opportunity stages could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving stages (for example, "Error while retrieving the Opportunity stage").
- 401 – Authentication failed or the access token is missing/expired.
