Sign in
Opportunity

get/v2/opportunity/categories

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v2/opportunity/categories
  • Auth: HTTP bearer

Response

idstring required

The category ID

companyIdstring required

The company ID

namestring required

The name of the category

rankstring required

The rank for ordering

showDueDateboolean required

Show due date on opportunities

showAmountboolean required

Show amount on opportunities

showCustomerboolean required

Show customer on opportunities

colorstring required

The color of the category (hex)

isLostboolean required

Whether this is a lost category

isDoneboolean required

Whether this is a done category

countnumber required

Number of opportunities in this category

totalAmountnumber required

Total amount of all opportunities in this category

Example response

[
  {
    "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
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.