List Opportunities Endpoint

GET /api/opportunities

List Opportunities Endpoint

cURL

curl --request GET \
  --url https://api.example.com/api/opportunities

200

{
  "opportunities": [
    {
      "company": "<string>",
      "contact_name": "<string>",
      "created_at": "<string>",
      "id": "<string>",
      "role_title": "<string>",
      "status": "interested",
      "updated_at": "<string>",
      "contact_linkedin": "<string>",
      "follow_up_date": "<string>",
      "location": "<string>",
      "notes": "<string>"
    }
  ],
  "total": 123
}

Query Parameters

status · string | null

Response

200

application/json

Successful Response

Response wrapper for list endpoint.

opportunities · OpportunitySummary · object[] · required

Show child attributes

total · integer · required