v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
SalesCycles

Retrieve Sales Cycle Stages

Retrieves configured Sales Cycle Stages for a company or group (if group_key argument provided)

get/v2/sales_cycles/{object_type}/stages

Path parameters

object_type'lead' | 'deal' required

The Sales Cycle type to retrieve stages for

Query parameters

group_keystring

Group key to retreive Stages for. Optional, defaults to all company Stages of this type

Response

Retrieves configured Sales Cycle Stages for a company or group (if group_key argument provided)

messagestring required
statusinteger required

Example response

{
  "data": {
    "items": [
      {
        "created_at": 1574181282399,
        "key": "co_a80cb515fe",
        "updated_at": 1574181282399,
        "api_name": "qualified_ent",
        "description": "Initial stage",
        "internal_status": "closed won",
        "name": "1st Stage",
        "position": 1,
        "sales_cycle_key": "scy_123",
        "sales_cycle_name": "Enterprise Sales Cycle"
      }
    ]
  }
}