Rpipedrive (version 0.1.1)

organizations.get_all: Get all organizations

Description

Function to Get all organizations from pipedrive.

Usage

organizations.get_all(user_id = NULL, filter_id = NULL,
  first_char = NULL, start = NULL, limit = NULL, sort = NULL,
  api_token = NULL, company_domain = "api")

Arguments

user_id

If supplied, only organizations owned by the given user will be returned.

filter_id

ID of the filter to use

first_char

If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive).

start

Pagination start

limit

Items shown per page

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

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

# NOT RUN {
organizations.get_all(api_token='token',company_domain='exp')
# }