Sign in
Opportunity

Changed on
get/v2/opportunity/{id}

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v2/opportunity/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

idstring required

The opportunity ID

createdAtnumber required

The creation date as Unix timestamp

namestring required

The name of the opportunity

descriptionstring

The description of the opportunity

dueDatenumber

The due date as Unix timestamp

amountnumber required

The amount in cents

rankstring required

The rank for ordering

customerIdstring required

The legacy customer ID

categoryIdstring required

The category ID

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": 1700000000,
  "name": "New Project Lead",
  "description": "Potential client interested in our services",
  "dueDate": 1700000000,
  "amount": 100000,
  "rank": "0|hzzzzz:",
  "customerId": "507f1f77bcf86cd799439011",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "category": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Qualified Leads",
    "rank": "0|hzzzzz:",
    "showDueDate": true,
    "showAmount": true,
    "showCustomer": true,
    "color": "#6366f1",
    "count": 5,
    "totalAmount": 15000
  },
  "customer": {
    "deliveryAddressIsSame": true
  }
}

Changes

  • bb3dad0e053fRevision changes
    • warning

      added the new XAF enum value to the ///////// response property for the response status

    • warning

      added the new XOF enum value to the ///////// response property for the response status

    • warning

      added the new XPF enum value to the ///////// response property for the response status

    This list may be incomplete.