Description Usage Arguments Value Examples
Function to Get all deals from pipedrive.
1 2 3 |
user_id |
If supplied, only deals matching the given user will be returned. |
filter_id |
ID of the filter to use |
stage_id |
If supplied, only deals within the given stage will be returned. |
status |
Only fetch deals with specific status. If omitted, all not deleted deals are fetched. This field has the following domains: (open; won; lost; deleted; all_not_deleted) |
start |
Pagination start |
limit |
Items shown per page. Default limit is 100, maximum limit is 500. |
sort |
Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). |
owned_by_you |
When supplied, only deals owned by you are returned. However filter_id takes precedence over owned_by_you when both are supplied. This field has the following domains: (0; 1) |
api_token |
To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference> |
company_domain |
How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain> |
return an object List()
1 | deals.get_all(api_token='token',company_domain='exp')
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.