Retrieve an opportunity

Retrieve an opportunity

 

Request Path Parameters
Parameter Type Required Description
org_id number Yes The unique identifier of your organization
id number Yes The unique identifier of the opportunity

 

Example Request & Response


$ curl https://api.custerem.com/<org_id>/opportunities/<id>/ \
-X GET \
-H 'Authorization: X-API-KEY <Your API Key>' \
-H 'Content-Type: application/json' \

 

200 OK

{
    "opportunity": {
        "id": 19,
        "status": {
            "id": 16,
            "name": "Appointment scheduled",
            "value": 16
        },
        "value": "200.00",
        "value_cycle": "A",
        "value_cycle_display": "Annual",
        "contact": 5,
        "estimated_close": "2022-02-22T00:00:00Z",
        "lead": {
            "id": 8,
            "company_name": "Custerem"
        },
        "notes": "This is notes field",
        "user": {
            "id": 2,
            "email": "hayri.cicek@custerem.com",
            "profile": {
                "name": "Hayri Cicek"
            }
        },
        "confidence": 22,
        "created_at": "2022-02-24T06:29:44.179059Z",
        "updated_at": "2022-02-24T06:29:44.179079Z"
    }
}

 

404 Not Found

{
    "status_code": 404,
    "message": "Opportunity with id 50 not found"
}