stages.get.deals: Get deals in a stage

Description Usage Arguments Value Examples

Description

Function to Get deals in a stage from pipedrive.

Usage

1
2
3
stages.get.deals(id, filter_id = NULL, user_id = NULL,
  everyone = NULL, start = NULL, limit = NULL, api_token = NULL,
  company_domain = "api")

Arguments

id

ID of the stage

filter_id

If supplied, only deals matching the given filter will be returned.

user_id

If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.

everyone

If supplied, filter_id and user_id will not be considered instead, deals owned by everyone will be returned. This field has the following domains: (0; 1)

start

Pagination start

limit

Items shown per page

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
stages.get.deals(id='e.g.',api_token='token',company_domain='exp')

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