Deal
List pinned deal views
List the deal views a user has pinned to the tab bar of the deals table, in tab order. Private views the user can access are included. Views the user can no longer access are left out.
GET
/
v1
/
deals
/
views
/
pinned
curl --request GET \
--url 'https://api.claap.io/v1/deals/views/pinned?userEmail=jane.doe%40example.com' \
--header 'X-Claap-Key: <api-key>'
{
"result": [
{
"viewId": "Vw3Hc9Lt5Kd1Qp7Zm2Rf6",
"name": "Enterprise pipeline",
"visibility": "Public",
"icon": ":rocket:",
"isDefault": false,
"ownerId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
"columns": [
{
"type": "Default",
"columnId": "Title",
"isHidden": false
},
{
"type": "Default",
"columnId": "Stage",
"isHidden": false
},
{
"type": "Default",
"columnId": "Amount",
"isHidden": false,
"width": 160
}
],
"filters": {
"statusIn": [
"Open"
],
"typeIn": [
"newbusiness"
]
},
"sort": [
{
"field": "AmountValue",
"order": "Desc"
}
]
},
{
"viewId": "Default_MyDeals",
"name": "My deals",
"visibility": "Public",
"icon": ":bust_in_silhouette:",
"isDefault": true,
"ownerId": "#global",
"columns": [
{
"type": "Default",
"columnId": "Title",
"isHidden": false
},
{
"type": "Default",
"columnId": "OwnerName",
"isHidden": false
},
{
"type": "Default",
"columnId": "Stage",
"isHidden": false
}
],
"filters": {
"ownerEmailIn": [
{
"type": "Me"
}
]
},
"sort": [
{
"field": "LastInteraction",
"order": "Desc"
}
]
},
{
"viewId": "Qz8Td2Gm6Wp4Yc1Bn7Kx3",
"name": "My deals at risk",
"visibility": "Private",
"isDefault": false,
"ownerId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
"columns": [
{
"type": "Default",
"columnId": "Title",
"isHidden": false
},
{
"type": "Default",
"columnId": "AiStatus",
"isHidden": false
}
],
"filters": {
"aiStatusIn": [
"AtRisk"
],
"ownerEmailIn": [
{
"type": "Email",
"email": "jane.doe@example.com"
}
]
},
"sort": [
{
"field": "LastInteraction",
"order": "Desc"
}
]
}
]
}Lists the deal views a user has pinned to the tab bar of the deals table, in tab order. A user who never changed their tab bar gets the built-in default views.
Pinned views follow the same access rules as the Claap application: they include the private views the user can access, and leave out views the user can no longer access. See pinned views.
curl --request GET \
--url 'https://api.claap.io/v1/deals/views/pinned?userEmail=jane.doe%40example.com' \
--header 'X-Claap-Key: <api-key>'
Authorizations
Query Parameters
Email address of the user whose pinned views are listed. It must belong to an active workspace member.
Example:
"jane.doe@example.com"
Response
Pinned deal views were successfully retrieved
Show child attributes
Show child attributes
⌘I
curl --request GET \
--url 'https://api.claap.io/v1/deals/views/pinned?userEmail=jane.doe%40example.com' \
--header 'X-Claap-Key: <api-key>'
{
"result": [
{
"viewId": "Vw3Hc9Lt5Kd1Qp7Zm2Rf6",
"name": "Enterprise pipeline",
"visibility": "Public",
"icon": ":rocket:",
"isDefault": false,
"ownerId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
"columns": [
{
"type": "Default",
"columnId": "Title",
"isHidden": false
},
{
"type": "Default",
"columnId": "Stage",
"isHidden": false
},
{
"type": "Default",
"columnId": "Amount",
"isHidden": false,
"width": 160
}
],
"filters": {
"statusIn": [
"Open"
],
"typeIn": [
"newbusiness"
]
},
"sort": [
{
"field": "AmountValue",
"order": "Desc"
}
]
},
{
"viewId": "Default_MyDeals",
"name": "My deals",
"visibility": "Public",
"icon": ":bust_in_silhouette:",
"isDefault": true,
"ownerId": "#global",
"columns": [
{
"type": "Default",
"columnId": "Title",
"isHidden": false
},
{
"type": "Default",
"columnId": "OwnerName",
"isHidden": false
},
{
"type": "Default",
"columnId": "Stage",
"isHidden": false
}
],
"filters": {
"ownerEmailIn": [
{
"type": "Me"
}
]
},
"sort": [
{
"field": "LastInteraction",
"order": "Desc"
}
]
},
{
"viewId": "Qz8Td2Gm6Wp4Yc1Bn7Kx3",
"name": "My deals at risk",
"visibility": "Private",
"isDefault": false,
"ownerId": "Xk2Rd7Mv4Bn9Ts1Lq6Wf3",
"columns": [
{
"type": "Default",
"columnId": "Title",
"isHidden": false
},
{
"type": "Default",
"columnId": "AiStatus",
"isHidden": false
}
],
"filters": {
"aiStatusIn": [
"AtRisk"
],
"ownerEmailIn": [
{
"type": "Email",
"email": "jane.doe@example.com"
}
]
},
"sort": [
{
"field": "LastInteraction",
"order": "Desc"
}
]
}
]
}