| Method | get.sales_funnel |
|---|---|
| Description | Getting a list of sales funnels |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering Criteria" |
fields |
array | no | See "View of Returned Data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Filtering | Sorting | Description |
|---|---|---|---|---|
ext_id |
string | yes | yes | External sales funnel identifier |
name |
string | yes | yes | Sales funnel name |
| Sales funnel stages | ||||
stages |
array | List of sales funnel stages | ||
stage_ext_id |
string | External stage identifier | ||
stage_name |
string | Stage name | ||
stage_status |
enum | Stage status. Possible statuses "in_process", "success", "failed" | ||
stage_order |
number | Stage number | ||
JSON request structure```json
{ "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"
]
} }
### JSON response structure```json
{
"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"
}
}
List of returned errors
See the section "List of errors for methods with the verb get"