Retrieves a list of sales funnels.

Method	get.sales_funnel
API version	—
Description	Retrieves a list of sales funnels.

Available to: Agents and clients

Request parameters

Name	Type	Required	Description
access_token	string	yes	Access token used to authenticate the request.
user_id	number	no	Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use "get.customer_users".
limit	number	no	Maximum number of records to return. See the "Paging" section.
offset	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
filter	object	no	Filtering criteria. See the "Filters" section.
fields	array	no	Fields to include in the response. See the "Viewing returned data" section.
sort	array	no	Sorting criteria. See the "Data sorting" section.

Response parameters

Name	Type	Filtering	Sorting	Description
ext_id	string	yes	yes	External sales funnel ID.
name	string	yes	yes	Sales funnel name.
Sales funnel stages
stages	array			Sales funnel stages.
stage_ext_id	string			External stage ID.
stage_name	string			Stage name.
stage_status	enum			Stage status. Valid values: in_process, success, failed.
stage_order	number			Stage order.

Example request

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.sales_funnel",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{
    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": [
            {
                "ext_id": "string",
                "name": "string",
                "stages": [
                    {
                        "stage_ext_id":"string",
                        "stage_name": "string",
                        "stage_status": "enum",
                        "stage_order": "number"
                    }
                ]
            }
        ],
        "metadata": "object"
    }
}

Possible errors

See the "Errors for get methods" section.