Pipedrive

Read deals with the company API token. The token cannot be limited to read-only.

What you can track

Deals (open pipeline, won, lost) from GET /api/v2/deals, which is listed on the deals reference. The JSON paths for amount and add time were not on the pages checked for this playbook. Preview with test_job and only then set extract. Do not invent data[].value.

Credential

A personal API token. Pipedrive tokens act as that user and cannot be scoped to reading. Create a user whose permission set is view-only and use that user’s token.

Host: api.pipedrive.com. Suggested name: PIPEDRIVE_TOKEN. The members-area guide sends it as the query api_token={{secret:PIPEDRIVE_TOKEN}}. Whether API v2 also wants a header was not on the token page. If test_job returns 401, stop and say so.

Where to get it

Account name → Company settings → Personal preferences → API. One active token per user per company. How to find the API token.

tlly job

Start here, then fix the extract paths from the preview:

{"series":"pipedrive_deals","cron":"0 7 * * *","request":{"url":"https://api.pipedrive.com/api/v2/deals?api_token={{secret:PIPEDRIVE_TOKEN}}"},"extract":{"format":"json","items":"data","date":"add_time","value":"value","aggregate":"sum"}}

items, date and value in that example are unverified. Paging: the deals index did not document a numeric page parameter in the text we saw. Do not set request.pages until the preview shows a page query tlly can increment. Otherwise one response is the whole job.

Gotchas

The token can change data if the user can. Prefer a view-only user.
v1 changelog routes still exist (GET /api/v1/deals/{id}/changelog). Prefer v2 for the list.
Currency is whatever the deal stores. Do not assume cents.

Alert ideas

Red when open pipeline (once the preview shows a real open-value field) is below target. Won deals per week as a second series.

Verification

Token location checked on the readme page linked above. GET /api/v2/deals is listed on the deals reference index. Response fields and the api_token query on v2 were not in those fetches: treat the sample job’s extract paths as unverified.