Deals

Export deals as CSV

The same list as the JSON endpoint, as a CSV file with the columns the account's list view shows. Accepts the same conditions and sort parameters; not paginated. Requires the user's export permission.

Filtered request example — Open deals in two stages, owned by one user, created last quarter, worth 10,000 or more, biggest first (as CSV):

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/deals.csv?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.csv

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/deals.csv
  • 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

deal_accountinteger

Only for external (multi-account) users: restricts results to deals in the account with this id. Ignored for everyone else.

deal_addressstring

Street address starts with this text (case-insensitive).

deal_address2string

Second address line starts with this text (case-insensitive).

deal_citystring

City starts with this text (case-insensitive).

deal_company_namestring

Returns records associated the the company that match a LIKE query on the name field

deal_countrystring

Country starts with this text (case-insensitive).

deal_created_by_userinteger

Returns records created by the User with this ID

deal_currencyinteger

Returns records associated to the currency with this ID

deal_idstring

Comma-separated list of deal IDs to return

deal_import_namestring

Returns records that match a LIKE query on the import_name field

deal_is_archived'Yes' | 'No'

Returns records with the given archived status

deal_loss_reasoninteger

Returns records associated to the Deal loss reason with this ID

deal_loss_reason_notesstring

Loss reason notes contain this text (case-insensitive).

deal_namestring

Returns records that match a LIKE query on the name field

deal_next_entrystring

Name of the next scheduled task or event contains this text (case-insensitive).

deal_ownerinteger

Returns records owned by the User with this ID

deal_owner_teaminteger

Returns records owned by members of the team with this ID

deal_percentageinteger

Probability equals this value; several values may be given. Alias of deal_probability.

deal_pipelineinteger

Returns records associated to the deal pipeline with this ID

deal_primary_contact_idinteger

Returns records associated to the Person with this ID

deal_probabilityinteger

Returns records with the given probability

deal_product_linesinteger[]

Returns records associated to the deal product lines with this ID

deal_revenue_typeinteger

Returns records associated to the revenue type with this ID

deal_shared_withinteger[]

Returns records shared with the Users with these ID

deal_sourceinteger

Returns records associated to the Deal source with this ID

deal_stageinteger

Returns records associated to the Deal stage with this ID

deal_stage_before_closedstring

Won or lost deals only: the name of the stage the deal was in immediately before closing contains this text.

deal_statestring

State or province starts with this text (case-insensitive).

deal_statusinteger

Returns records associated to the Deal status with this ID

deal_summarystring

Returns records that match a LIKE query on the summary field

deal_tagsinteger[]

Returns records associated to the tags with these ID

deal_updated_by_userinteger

Returns records updated by the User with this ID

deal_won_reasoninteger

Returns records associated to the Deal won reason with this ID

deal_won_reason_notesstring

Won reason notes contain this text (case-insensitive).

deal_zipstring

Postal code starts with this text.

lead_sourceinteger

Returns records associated to the Lead source with this ID

person_all_emailsstring

Any of the person's email addresses (work, home, secondary) equals this value exactly. Several values may be given.

person_bounced'Yes' | 'No'

Returns records with the given bounced state

person_citystring

Returns records that match a LIKE query on the city field

person_company_namestring

Returns records that match a LIKE query on the name of the associated Company

person_countrystring

Returns records that match a LIKE query on the country field

person_created_by_userinteger

Returns records created by the User with this ID

person_emailstring

Returns records that match a LIKE query on the email address field

person_email2string

Returns records that match a LIKE query on the other email address field

person_email_instring

Work email address is exactly one of the given values; several values may be given.

person_faxstring

Returns records that match a LIKE query on the fax field

person_first_namestring

Returns records that match a LIKE query on the first_name field

person_full_namestring

Returns records that match a LIKE query on the full name (combination of first_name and last_name fields)

person_home_address_1string

Returns records that match a LIKE query on the home address 1 field

person_home_address_2string

Returns records that match a LIKE query on the home address 2 field

person_home_citystring

Returns records that match a LIKE query on the home city field

person_home_countrystring

Returns records that match a LIKE query on the home country field

person_home_emailstring

Returns records that match a LIKE query on the home email address field

person_home_phonestring

Returns records that match a LIKE query on the home_phone field

person_home_statestring

Returns records that match a LIKE query on the home state field

person_home_zipstring

Returns records that match a LIKE query on the home zip code field

person_idinteger

Returns records with this Person ID

person_import_namestring

Returns records that match a LIKE query on the import name field

person_is_key_contact'Yes' | 'No'

Returns records with the given key contact state

person_last_namestring

Returns records that match a LIKE query on the last_name field

person_linked_in_urlstring

LinkedIn URL contains this text.

person_mobilestring

Returns records that match a LIKE query on the mobile field

person_namestring

Returns records that match a LIKE query on the first_name or last_name fields

person_ownerinteger

Returns records owned by the User with this ID

person_owner_teaminteger

Returns records owned by members of the team with this ID

person_phonestring

Returns records that match a LIKE query on the phone field

person_phonesstring

Returns records that match a LIKE query on the phone, home_phone or mobile field

person_phones_containsstring

Any of the person's phone numbers contains these digits; formatting characters are ignored.

person_positionstring

Returns records that match a LIKE query on the position field

person_relationshipstring

Returns records that match a LIKE query on the relationship field

person_shared_withinteger[]

Returns records shared with the Users with these ID

person_simple_searchstring

Returns records that match a LIKE query on first_name, last_name, email or associated Company name

person_statestring

Returns records whose work state starts with this value. A US state name and its two-letter code match each other (Texas also returns TX)

person_statusinteger

Returns records associated to the Lead status with this ID

person_summarystring

Returns records that match a LIKE query on the summary field

person_tag_namesstring[]

Returns records that match a LIKE query on the tag names

person_tagsinteger[]

Returns records associated to the tags with these IDs

person_type'Lead' | 'Contact'

Returns records of the specified type - either Contact or Lead

person_unsubscribed'Yes' | 'No'

Returns records with the given unsubscribed state

person_websitestring

Returns records that match a LIKE query on the website field

person_work_address_1string

Returns records that match a LIKE query on the work address 1 field

person_work_address_2string

Returns records that match a LIKE query on the work address 2 field

person_work_zipstring

Work postal code starts with this text. Alias of person_zip.

person_zipstring

Returns records that match a LIKE query on the zip code field

company_addressstring

Return records that have an address that exactly matches or starts with the provided string

company_address2string

Return records that have a secondary address that exactly matches or starts with the provided string

company_citystring

Return records that have a city that exactly matches or starts with the provided string

company_countrystring

Country starts with this text (case-insensitive).

company_created_by_userinteger

Return records that were created by the given user

company_descriptionstring

Return records that have a description that exactly matches or starts with the provided string

company_emailstring

Return records that have an email that exactly matches or starts with the provided string

company_faxstring

Return records that have a fax number that exactly matches or starts with the provided string

company_idinteger

The company with given company_id. Note: you can specify a comma-separated list of ids to retrieve more companies at once

company_import_namestring

Return records that have an import name that exactly matches or starts with the provided string

company_is_customer'Yes' | 'No'

Return records that are customers

company_linked_in_urlstring

LinkedIn URL contains this text.

company_namestring

Return records that have a name that exactly matches or starts with the provided string

company_name_eqstring

Return records that have a name that exactly matches the provided string

company_ownerinteger

Return records that have an owner with the given ID

company_owner_teaminteger

Return records that have an owner in the given team

company_phonestring

Return records that have a phone number that exactly matches or starts with the provided string

company_phone2string

Second phone number contains these digits; formatting characters are ignored.

company_phone3string

Third phone number contains these digits; formatting characters are ignored.

company_phone4string

Fourth phone number contains these digits; formatting characters are ignored.

company_phones_containsstring

Any of the company's phone numbers contains these digits; formatting characters are ignored.

company_shared_withinteger[]

Return records that have been shared with the given users

company_statestring

Return records that have a state that exactly matches or starts with the provided string

company_tagsinteger[]

Return records that have the given tag IDs

company_webstring

Return records that have a website that exactly matches or starts with the provided string

company_worked_on_byinteger

Return records that have been worked on by the given user

company_zipstring

Return records that have a postal code that exactly matches or starts with the provided string

customer_health_scoreinteger

Return records that have a customer health score that exactly matches the provided integer

next_milestone_namestring

The customer's next milestone name contains this text.

next_milestone_statusstring

The customer's next milestone has this status: not_started, in_progress, blocked or complete, or the number it is stored as (0 to 3). The next milestone is the earliest one not yet complete, so complete normally matches nothing. none or __NONE__ matches customers with no next milestone, __HAS_VALUE__ those with one; any other value matches nothing.

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"
}
sortstring

Sort key, - prefix for descending (see Filtering)

Response

CSV file

Changes

No recorded changes to this operation across all 1 revision of this API.