Deals
List deals
Filtered request example — Open deals in two stages, owned by one user, created last quarter, worth 10,000 or more, biggest first:
curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
"https://api.pipelinecrm.com/api/v3/deals.json?conditions[deal_stage][]=3&conditions[deal_stage][]=4&conditions[deal_owner][]=13&conditions[deal_created][selection]=last_quarter&conditions[deal_value][from]=10000&sort=-deal_value&per_page=50"
get/deals
Request
- Base URL: https://api.pipelinecrm.com/api/v3
- URL: https://api.pipelinecrm.com/api/v3/deals
- Auth: one of:
- HTTP bearer
- HTTP bearer and API key in header app-key
- API key in query parameter api_key and API key in query parameter app_key
Query parameters
Filters as bracketed query parameters, for example ?conditions[deal_stage][]=3&conditions[deal_created][selection]=last_30. Each key below is one filter; see the Filtering guide for the value formats (ids, lists, date ranges, number ranges, custom fields) and the example above for a complete request.
{
"deal_address": "100 Main",
"deal_age": "last_30",
"deal_bonus": {
"from": 1000,
"to": 5000
},
"deal_city": "Seattle",
"deal_closed": "last_30",
"deal_closed_time": "last_30",
"deal_closing": "last_30",
"deal_commission": {
"from": 1000,
"to": 5000
},
"deal_company_name": "Acme Inc.",
"deal_country": "United",
"deal_created": "last_30",
"deal_created_at": "last_30",
"deal_created_by_user": 1,
"deal_currency": 125,
"deal_date_of_first_activity": "last_30",
"deal_days_active": {
"from": 1000,
"to": 5000
},
"deal_days_in_stage": {
"from": 1000,
"to": 5000
},
"deal_days_since_last_activity": {
"from": 1000,
"to": 5000
},
"deal_exp_close": "last_30",
"deal_expected_close_date": "last_30",
"deal_hours_to_first_activity": {
"from": 1000,
"to": 5000
},
"deal_id": "111,112,113",
"deal_id_not": 123,
"deal_import_name": "Import 1",
"deal_imported_at": "last_30",
"deal_is_archived": "Yes",
"deal_loss_reason": 1,
"deal_modified": "last_30",
"deal_name": "Inc.",
"deal_next_entry_due": "last_30",
"deal_owner": 13473,
"deal_owner_team": 13473,
"deal_percentage": 75,
"deal_pipeline": 1,
"deal_primary_contact_id": 1,
"deal_probability": 75,
"deal_product_lines": [
1,
2
],
"deal_revenue_type": 1,
"deal_shared_with": [
1,
2,
3
],
"deal_source": 48284,
"deal_stage": 33234,
"deal_stage_before_closed": "Negotiation",
"deal_state": "WA",
"deal_status": 1,
"deal_summary": "This is a summary",
"deal_tags": [
1,
2,
3
],
"deal_time_to_close": {
"from": 1000,
"to": 5000
},
"deal_time_to_dollar": {
"from": 1000,
"to": 5000
},
"deal_updated_at": "last_30",
"deal_updated_by_user": 1,
"deal_value": {
"from": 1000,
"to": 5000
},
"deal_viewed_at": "last_30",
"deal_weighted_forecast": {
"from": 1000,
"to": 5000
},
"deal_won_reason": 1,
"deal_zip": "981",
"exp_close": "last_30",
"lead_source": 63424,
"person_all_emails": "jane@example.com",
"person_city": "New York Ci",
"person_company_id": 123,
"person_company_name": "Inc.",
"person_converted": "last_30",
"person_converted_at": "last_30",
"person_country": "United States",
"person_created": "last_30",
"person_created_at": "last_30",
"person_created_by_user": 145735,
"person_date_of_first_activity": "last_30",
"person_days_since_last_activity": {
"from": 1000,
"to": 5000
},
"person_email_in": "jane@example.com",
"person_fax": "(514) 897",
"person_first_name": "John",
"person_full_name": "John D. Rockefel",
"person_home_address_1": "123 Fake St.",
"person_home_address_2": "Suite 101",
"person_home_city": "New York Ci",
"person_home_country": "United States",
"person_home_phone": "(514) 673",
"person_home_state": "Dakota",
"person_home_zip": "64",
"person_hours_to_first_activity": {
"from": 1000,
"to": 5000
},
"person_id": 1,
"person_id_not": 123,
"person_import_name": "Import",
"person_imported_at": "last_30",
"person_last_emailed_at": "last_30",
"person_last_name": "Rockefel",
"person_mobile": "(514) 673",
"person_modified": "last_30",
"person_name": "John",
"person_owner": 145735,
"person_owner_team": 145735,
"person_phone": "(514) 673",
"person_phones": "(514) 673",
"person_phones_contains": "555-0100",
"person_position": "VP of",
"person_relationship": "Manager",
"person_shared_with": [
1,
2,
3
],
"person_simple_search": "Bell",
"person_source": 123,
"person_state": "Dakota",
"person_status": 82927,
"person_summary": "Summary",
"person_tag_names": [
"tag1",
"tag2"
],
"person_tags": [
1,
2
],
"person_updated_at": "last_30",
"person_viewed_at": "last_30",
"person_website": "web.com",
"person_work_address_1": "123 Fake St.",
"person_work_address_2": "Suite 101",
"person_work_zip": "981",
"person_zip": "64",
"company_address": "Suite 101.",
"company_address2": "123 Fake St.",
"company_city": "Denver",
"company_country": "United",
"company_created": "last_30",
"company_created_at": "last_30",
"company_created_by_user": 1,
"company_description": "CRM",
"company_email": "suppert@pipelinecrm",
"company_fax": "(514) 897",
"company_id": 111112113,
"company_id_not": 123,
"company_import_name": "Import 1",
"company_imported_at": "last_30",
"company_is_customer": "Yes",
"company_modified": "last_30",
"company_name": "Pipeline",
"company_name_eq": "Pipeline",
"company_owner": 1,
"company_owner_team": 1,
"company_phone": "(514) 673",
"company_phones_contains": "555-0100",
"company_shared_with": [
1,
2,
3
],
"company_state": "Colorado",
"company_tags": [
1,
2,
3
],
"company_total_pipeline": {
"from": 1000,
"to": 5000
},
"company_updated": "last_30",
"company_updated_at": "last_30",
"company_web": "pipelinecrm.com",
"company_won_value": {
"from": 1000,
"to": 5000
},
"company_worked_on_by": 1,
"company_zip": "11001",
"customer_days_in_health": {
"from": 1000,
"to": 5000
},
"customer_health_score": 1,
"next_milestone_due": "last_30",
"next_milestone_status": "in_progress"
}Response
Successful Response
Example response
{
"entries": [
{
"id": 4521,
"owner": {
"id": 13,
"full_name": "Sam Okafor"
},
"primary_contact": {
"id": 8802,
"full_name": "Jane Rivera"
},
"people": [
{
"id": 8802,
"first_name": "Jane",
"last_name": "Rivera"
},
{
"id": 8815,
"first_name": "Marcus",
"last_name": "Chen"
}
],
"collaborators": [
{
"id": 27,
"first_name": "Priya",
"last_name": "Natarajan"
}
],
"company": {
"id": 3310,
"name": "Acme Corporation"
},
"currency": {
"name": "US Dollar",
"code": "USD",
"symbol": "$"
},
"deal_stage": {
"id": 3,
"name": "Proposal sent",
"percent": 50
},
"deal_loss_reason": {
"id": 1,
"name": "Price"
},
"source": {
"id": 5,
"name": "Website"
},
"possible_notify_user_ids": [
1,
2,
3,
4,
5
],
"next_task_name": "Send revised quote",
"next_task_id": 5602,
"next_task_due": "2026/09/08",
"tags": [
{
"id": 3,
"name": "Enterprise"
},
{
"id": 9,
"name": "Renewal"
}
],
"created_at": "2026-09-01 14:22:07",
"updated_at": "2026-09-01 14:22:07",
"name": "Acme Corporation - Q4 renewal",
"summary": "Renewal of the 120-seat plan; legal review in progress.",
"user_id": 13,
"status": 1,
"expected_close_date": "2026-10-15",
"value": "12000.0",
"primary_contact_id": 8802,
"person_ids": [
1,
2,
3
],
"shared_user_ids": [
1,
2,
3
],
"company_id": 3310,
"company_name": "Acme Corporation",
"probability": 60,
"deal_stage_id": 3,
"deal_loss_reason_notes": "Too expensive",
"deal_won_reason_id": 4,
"deal_won_reason_notes": "Great value for the price",
"deal_source": 5,
"custom_fields": {
"custom_label_90": [
45,
46,
47
],
"custom_label_5": "text val"
},
"tag_ids": [
3,
4,
5
],
"address_1": "123 Main St.",
"address_2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"pagination": {
"page": 1,
"per_page": 200,
"total": 670,
"pages": 4,
"total_in_account": 1204,
"page_var": "page",
"url": "/api/v3/deals.json"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.