Pipedrive

Writes

• Create person

  read back

  pipedrive-create-person

  Create one person with a name and a work email, and optionally phones, an organization and an owner.

• Update person

  read back

  pipedrive-update-person

  Update one person's name, emails, phones, organization or owner. Only the fields you pass change; emails and phones are sent as the full list you give.

• Delete person

  acknowledged

  pipedrive-delete-person

  Delete one person. Pipedrive marks the person deleted and removes them for good after 30 days.

• Create organization

  read back

  pipedrive-create-organization

  Create one organization with a name and optionally an owner.

• Create deal

  read back

  pipedrive-create-deal

  Create one open deal with a title, and optionally a person, an organization, a pipeline and stage, a value and currency, an owner and an expected close date. Pipedrive chooses the pipeline and stage when they are left out. The value records what the deal is worth; no money moves.

• Update deal

  read back

  pipedrive-update-deal

  Update one deal's title, value, currency, owner, expected close date, person or organization. Only the fields you pass change. Use move-deal-stage for the stage and set-deal-status for won or lost.

• Move deal stage

  read back

  pipedrive-move-deal-stage

  Move one deal to another stage. Stage ids come from list-stages.

• Set deal status

  read back

  pipedrive-set-deal-status

  Mark one deal won or lost, or reopen it. A lost reason can be given with lost only (Pipedrive's rule).

• Delete deal

  read back

  pipedrive-delete-deal

  Delete one deal. Pipedrive marks it deleted and removes it for good after 30 days; until then it can be restored in Pipedrive.

• Create activity

  read back

  pipedrive-create-activity

  Create one activity (a call, meeting, task or another type the company has) with a subject and a type, linked to a deal or an organization, optionally due at a date and time, with a note.

• Complete activity

  read back

  pipedrive-complete-activity

  Mark one activity done.

• Add note

  read back

  pipedrive-add-note

  Add one note to a deal, a person or an organization. Give at least one of deal_id, person_id and org_id, or Pipedrive refuses it. The content is HTML, which Pipedrive sanitizes.

Reads

• Search deals

  pipedrive-search-deals

  Search deals by title, notes and custom fields. Returns up to 20 matches a page, each with id, title, value, currency, status, stage, owner, person and organization. Filter by person, organization or status. When additional_data.next_cursor is present, pass it as cursor for the next page. Pipedrive caps a filtered search at 2000 deals.

• Search persons

  pipedrive-search-persons

  Search people by name, email, phone, notes and custom fields. Returns up to 20 matches a page, each with id, name, emails, phones, owner and organization. Filter by organization. When additional_data.next_cursor is present, pass it as cursor for the next page.

• Search organizations

  pipedrive-search-organizations

  Search organizations by name, address, notes and custom fields. Returns up to 20 matches a page, each with id, name, address and owner. When additional_data.next_cursor is present, pass it as cursor for the next page.

• List deals

  pipedrive-list-deals

  List deals, 20 a page, filtered by owner, person, organization, pipeline, stage, status or last update. Without status it returns open, won and lost deals; status deleted returns deals deleted in the last 30 days. Archived deals are not listed. Each deal has its id, title, value, currency, status, pipeline, stage, person, organization and dates. When additional_data.next_cursor is present, pass it as cursor for the next page.

• Get deal

  pipedrive-get-deal

  Get one deal: title, value, currency, status, pipeline and stage, person, organization, owner, dates, lost reason and custom field values (keyed by the field's hash).

• Get person

  pipedrive-get-person

  Get one person: name, emails, phones, organization, owner, labels and custom field values (keyed by the field's hash).

• Get organization

  pipedrive-get-organization

  Get one organization: name, address, owner, labels and custom field values (keyed by the field's hash).

• List activities

  pipedrive-list-activities

  List activities (calls, meetings, tasks and other types), 20 a page, filtered by owner, deal, person, organization or done. Each has its id, subject, type, due date and time, duration, done, and the deal, person and organization it is linked to. When additional_data.next_cursor is present, pass it as cursor for the next page.

• Get activity

  pipedrive-get-activity

  Get one activity: subject, type, due date and time, duration, done, note, and the deal, person and organization it is linked to.

• List pipelines

  pipedrive-list-pipelines

  List the company's pipelines, 50 a page: id, name and order. When additional_data.next_cursor is present, pass it as cursor for the next page.

• List stages

  pipedrive-list-stages

  List stages, 50 a page, of one pipeline or of all: id, name, order in the pipeline and pipeline_id. A deal's stage_id is one of these. When additional_data.next_cursor is present, pass it as cursor for the next page.

• List notes

  pipedrive-list-notes

  List notes, 10 a page, on one deal, person or organization, or all of them. Each has its id, content (HTML), author and the deal, person and organization it is on. Pages with start: when additional_data.pagination.more_items_in_collection is true, pass additional_data.pagination.next_start as start. A long note can be cut at the response limit.

• Get note

  pipedrive-get-note

  Get one note: its content (HTML), author, dates and the deal, person and organization it is on.