3.0 KiB
3.0 KiB
Pipedrive Routing Reference
App name: pipedrive
Base URL proxied: api.pipedrive.com
API Path Pattern
/pipedrive/api/v1/{resource}
Common Endpoints
List Deals
GET /pipedrive/api/v1/deals?status=open&limit=50
Get Deal
GET /pipedrive/api/v1/deals/{id}
Create Deal
POST /pipedrive/api/v1/deals
Content-Type: application/json
{
"title": "New Enterprise Deal",
"value": 50000,
"currency": "USD",
"person_id": 123,
"org_id": 456,
"stage_id": 1,
"expected_close_date": "2025-06-30"
}
Update Deal
PUT /pipedrive/api/v1/deals/{id}
Content-Type: application/json
{
"title": "Updated Deal Title",
"value": 75000,
"status": "won"
}
Delete Deal
DELETE /pipedrive/api/v1/deals/{id}
Search Deals
GET /pipedrive/api/v1/deals/search?term=enterprise
List Persons
GET /pipedrive/api/v1/persons
Create Person
POST /pipedrive/api/v1/persons
Content-Type: application/json
{
"name": "John Doe",
"email": ["john@example.com"],
"phone": ["+1234567890"],
"org_id": 456
}
List Organizations
GET /pipedrive/api/v1/organizations
Create Organization
POST /pipedrive/api/v1/organizations
Content-Type: application/json
{
"name": "Acme Corporation",
"address": "123 Main St, City, Country"
}
List Activities
GET /pipedrive/api/v1/activities?type=call&done=0
Create Activity
POST /pipedrive/api/v1/activities
Content-Type: application/json
{
"subject": "Follow-up call",
"type": "call",
"due_date": "2025-03-15",
"due_time": "14:00",
"deal_id": 789,
"person_id": 123
}
List Pipelines
GET /pipedrive/api/v1/pipelines
List Stages
GET /pipedrive/api/v1/stages?pipeline_id=1
Create Note
POST /pipedrive/api/v1/notes
Content-Type: application/json
{
"content": "Meeting notes: Discussed pricing and timeline",
"deal_id": 789,
"pinned_to_deal_flag": 1
}
Get Current User
GET /pipedrive/api/v1/users/me
Notes
- IDs are integers
- Email and phone fields accept arrays for multiple values
visible_tovalues: 1 (owner only), 3 (entire company), 5 (owner's visibility group), 7 (entire company and visibility group)- Deal status:
open,won,lost,deleted - Use
startandlimitfor pagination - Custom fields are supported via their API key (e.g.,
abc123_custom_field)