organizations.get.deals: List deals associated with an organization

Description Usage Arguments Value Examples

Description

Function to List deals associated with an organization from pipedrive.

Usage

1
2
3
organizations.get.deals(id, start = NULL, limit = NULL,
  status = NULL, sort = NULL, only_primary_association = NULL,
  api_token = NULL, company_domain = "api")

Arguments

id

ID of an organization

start

Pagination start

limit

Items shown per page

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)

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).

only_primary_association

If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. 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>

Value

return an object List()

Examples

1
organizations.get.deals(id='e.g.',api_token='token',company_domain='exp')

Rpipedrive documentation built on May 15, 2019, 1:06 a.m.