Skip to main content
GET
/
api
/
v1
/
opportunities
List opportunities
curl --request GET \
  --url https://supmaya.com/api/v1/opportunities \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "summary": "<string>",
      "value": 123,
      "contact_id": 123,
      "agent_id": 123,
      "follow_up_requested": true,
      "follow_up_type": "<string>",
      "webhook_sent": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

contact_id
integer<int64>

Filter opportunities by contact ID

created_at
string<date>

Filter opportunities created on this date

status
enum<string>

Filter opportunities by status

Available options:
new,
qualified,
won,
lost

Response

Paginated opportunities

data
object[]
meta
object