User.com REST API Docs # Get deals by tag
You can return all deals including a specific tag.
GET /tags/:id/deals/
| Attributes | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A unique identifier for the tag which is given by User.com automatically. |
# Request
- CURL
- JavaScript
- PHP
- Python
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2"
"https://<your_app_subdomain>.user.com/api/public/tags/:id/deals/"
# Response
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 3300,
"name": "Deal 1",
"value": "525.00",
"currency": "USD",
"custom_id": null,
"stage": 25898,
"pipeline": 4338,
"assigned_to": null,
"restricted_to": null,
"agent": 5567,
"company": null,
"person": 22266722,
"status": "1",
"scope": "2",
"created_by": 5567,
"created_at": "2017-06-27T14:51:04.331287Z",
"updated_at": "2017-07-04T16:54:47.907574Z",
"attributes": [
{
"value": "attr value",
"name_std": "deal_attr",
"name": "deal attr",
"description": "attribute description",
"id": 22
},
{
"value": "attr value",
"name_std": "deal_attr_2",
"name": "deal attr 2",
"description": " attribute description",
"id": 23
}
],
"tags": [
{
"id": 31,
"name": "My tag",
}
],
"activities_status": "3",
"activities_status_updated_at": "2017-07-04T16:54:47.907238Z",
"expected_close_date": null
},
{
"id": 3299,
"name": "Deal 2",
"value": "1000.00",
"currency": "USD",
"custom_id": null,
"stage": 25903,
"pipeline": 4338,
"assigned_to": null,
"restricted_to": null,
"agent": 5567,
"company": null,
"person": 22132488,
"status": "1",
"scope": "2",
"created_by": 5567,
"created_at": "2017-06-27T14:50:21.944576Z",
"updated_at": "2017-06-27T14:50:21.944596Z",
"attributes": [
{
"value": "attr value",
"name_std": "deal_attr",
"name": "deal attr",
"description": "attribute description",
"id": 22
},
{
"value": "attr value",
"name_std": "deal_attr_2",
"name": "deal attr 2",
"description": " attribute description",
"id": 23
}
],
"tags": [
{
"id": 31,
"name": "My tag",
}
],
"activities_status": "0",
"activities_status_updated_at": "2017-06-27T14:50:21.944174Z",
"expected_close_date": null
},
{
"id": 2787,
"name": "Deal 3",
"value": "124.00",
"currency": "EUR",
"custom_id": null,
"stage": 25901,
"pipeline": null,
"assigned_to": null,
"restricted_to": null,
"agent": 5567,
"company": null,
"person": 22132488,
"status": "1",
"scope": "2",
"created_by": 5567,
"created_at": "2017-06-21T12:26:34.268295Z",
"updated_at": "2017-06-27T14:49:01.166811Z",
"activities_status": "0",
"activities_status_updated_at": "2017-06-27T14:49:01.166622Z",
"expected_close_date": "2017-06-21"
}
]
}