Skip to main content
New to Corsair? See API access, authentication, and error handling.

Activities

create

activities.create Create a calendar activity; attendees get an email invitation when calendar sync is on Risk: destructive
Input OAuth requires activities:full. All request properties are optional in the v2 schema. Use participants to set the person; the response data is an activity object. When the owner has calendar sync on, Pipedrive emails an invitation to every attendee, so this operation needs approval. The documented API token cost is 5 tokens.
Output

delete

activities.delete Mark an activity deleted Risk: destructive
Input OAuth requires activities:full. Deletion marks an activity deleted; Pipedrive permanently deletes it after 30 days. The documented API token cost is 3 tokens. Output

get

activities.get Get an activity by its numeric ID Risk: read
Input OAuth requires activities:read or activities:full. include_fields currently accepts attendees. To associate a person on create/update, use participants with primary: true; person_id is not an accepted body field. The documented API token cost is 1 token. Output

list

activities.list List activities with cursor pagination and filters Risk: read
Input OAuth requires activities:read or activities:full. The limit is 1–500; use the opaque additional_data.next_cursor value as cursor. Array filters are comma-separated. The documented API token cost is 10 tokens. Output

update

activities.update Update a calendar activity; attendees get updated invitations when calendar sync is on Risk: destructive
Input OAuth requires activities:full. The path ID is supplied as the input id and omitted from the JSON body. With calendar sync on, changed guests, time or place email updated invitations or cancellations to attendees. The documented API token cost is 5 tokens.
Output

Deals

create

deals.create Create a deal Risk: write
Input API-token authentication is sent using Pipedrive’s documented x-api-token header. OAuth 2.0 uses a Bearer access token and requires deals:full. The documented API token cost is 5 tokens. Output

delete

deals.delete Delete a deal Risk: destructive
Input OAuth requires the deals:full scope. The documented API token cost is 3 tokens. Output

get

deals.get Get a deal by its numeric ID Risk: read
Input OAuth requires the deals:read or deals:full scope. The documented API token cost is 1 token. Output

list

deals.list List deals with cursor pagination and filters Risk: read
Input The list operation forwards Pipedrive’s opaque cursor and returns additional_data.next_cursor; pass that value as cursor to request the next page. List array query parameters are serialized as comma-separated values as required by the OpenAPI form/explode=false contract. Its documented API token cost is 10 tokens. Output

update

deals.update Update a deal Risk: write
Input OAuth requires the deals:full scope. The documented API token cost is 5 tokens. Output

Organizations

create

organizations.create Create an organization Risk: write
Input OAuth requires contacts:full. Organization custom_fields values are arbitrary JSON; set a custom field to null to clear it, and do not send an empty array to clear a multi-option set field. The documented API token cost is 5 tokens.
Output

delete

organizations.delete Delete an organization Risk: destructive
Input OAuth requires contacts:full. Deletion marks the organization deleted; Pipedrive permanently removes it after 30 days. The documented API token cost is 3 tokens. Output

get

organizations.get Get an organization by its numeric ID Risk: read
Input OAuth requires contacts:read or contacts:full. The documented API token cost is 1 token. Output

list

organizations.list List organizations with cursor pagination and filters Risk: read
Input OAuth requires contacts:read or contacts:full. List arrays are comma-separated; forward additional_data.next_cursor as cursor. The documented API token cost is 10 tokens. Output

update

organizations.update Update an organization Risk: write
Input OAuth requires contacts:full. Organization custom_fields values are arbitrary JSON; set a custom field to null to clear it, and do not send an empty array to clear a multi-option set field. The documented API token cost is 5 tokens.
Output

Persons

create

persons.create Create a person Risk: write
Input OAuth requires contacts:full. The im, postal_address, notes, birthday, and job_title fields require company contact sync; marketing_status requires the Campaigns product. The documented API token cost is 5 tokens.
Output

delete

persons.delete Delete a person Risk: destructive
Input OAuth requires contacts:full. The documented API token cost is 3 tokens. Output

get

persons.get Get a person by its numeric ID Risk: read
Input OAuth requires contacts:read or contacts:full. The documented API token cost is 1 token. Output

list

persons.list List persons with cursor pagination and filters Risk: read
Input OAuth requires contacts:read or contacts:full. List arrays are comma-separated; forward additional_data.next_cursor as cursor. The documented API token cost is 10 tokens. Output

update

persons.update Update a person Risk: write
Input OAuth requires contacts:full. The im, postal_address, notes, birthday, and job_title fields require company contact sync; marketing_status requires the Campaigns product. The documented API token cost is 5 tokens.
Output

Products

create

products.create Create a product Risk: write
Input OAuth requires products:full. name is required and cannot be empty; prices require both price and currency. billing_frequency and billing_frequency_cycles are available on Growth and above, and cycles are limited to 1–208 when non-null. The documented API token cost is 5 tokens.
Output

delete

products.delete Delete a product Risk: destructive
Input OAuth requires products:full. Deletion marks the product deleted; Pipedrive permanently removes it after 30 days. The documented API token cost is 3 tokens. Output

duplicate

products.duplicate Duplicate a product and its documented fields Risk: write
Input OAuth requires products:full. This creates a duplicate including all variations, prices, and custom fields using POST /products/{id}/duplicate with an empty JSON body. The documented API token cost is 5 tokens. Output

followers.changelog

products.followers.changelog List product follower changes with cursor pagination Risk: read
Input OAuth requires products:read or products:full. The maximum page size is 500; pass additional_data.next_cursor as cursor. The documented API token cost is 10 tokens. Output

followers.create

products.followers.create Add a user as a product follower Risk: write
Input OAuth requires products:full. The request body requires the user_id of the user to add as a follower. The documented API token cost is 5 tokens. Output

followers.delete

products.followers.delete Remove a product follower Risk: destructive
Input OAuth requires products:full. follower_id identifies the following user in the path. The documented API token cost is 3 tokens. Output

followers.list

products.followers.list List product followers with cursor pagination Risk: read
Input OAuth requires products:read or products:full. The maximum page size is 500; pass additional_data.next_cursor as cursor. The documented API token cost is 10 tokens. Output

get

products.get Get a product by ID Risk: read
Input OAuth requires products:read or products:full. The documented API token cost is 1 token. Output

images.delete

products.images.delete Delete a product image Risk: destructive
Input OAuth requires products:full. This deletes the product’s image. The documented API token cost is 6 tokens. Output

images.get

products.images.get Get product image metadata and public URL Risk: read
Input OAuth requires products:read or products:full. The response is image metadata and a public URL, not image bytes; Pipedrive says the public URL is valid for 7 days. The documented API token cost is 10 tokens. Output

images.update

products.images.update Replace a product image with binary data Risk: write
Input OAuth requires products:full. In this example, file is an existing runtime File containing the image; its actual bytes are wrapped in a Blob for the required multipart/form-data binary field data. Pass real image bytes. Pipedrive needs a file name with an extension: pass file_name, or the plugin names it image.<type> from the Blob type (a name without an extension saves an image Pipedrive then fails to read). The documented API token cost is 20 tokens. Output

images.upload

products.images.upload Upload a binary image for a product Risk: write
Input OAuth requires products:full. In this example, file is an existing runtime File containing the image; its actual bytes are wrapped in a Blob for the required multipart/form-data binary field data. Pass real image bytes. Pipedrive needs a file name with an extension: pass file_name, or the plugin names it image.<type> from the Blob type (a name without an extension saves an image Pipedrive then fails to read). The documented API token cost is 20 tokens. Output

list

products.list List products with filters and cursor pagination Risk: read
Input OAuth requires products:read or products:full. The maximum page size is 500; pass additional_data.next_cursor as cursor. ids accepts up to 100 IDs and custom_fields up to 15 unique keys. The documented API token cost is 10 tokens. Output

products.search Search products by term Risk: read
Input OAuth accepts products:read, products:full, or search:read. term is 2–100 characters, or one character with exact_match: true; the limit is at most 100 and pagination uses next_cursor. Search has a separate burst limit of 10 requests per 2-second window across plans and authentication types. The documented API token cost is 20 tokens. Output

update

products.update Update a product Risk: write
Input OAuth requires products:full. This is a partial PATCH; prices require price and currency when supplied. Billing frequency fields are available on Growth and above. The documented API token cost is 5 tokens.
Output

variations.create

products.variations.create Create a product variation Risk: write
Input OAuth requires products:full. name is required and limited to 255 characters; each supplied price requires price and currency. The documented API token cost is 5 tokens.
Output

variations.delete

products.variations.delete Delete a product variation Risk: destructive
Input OAuth requires products:full. This removes the specified product variation. The documented API token cost is 3 tokens. Output

variations.list

products.variations.list List product variations with cursor pagination Risk: read
Input OAuth requires products:read or products:full. The maximum page size is 500; pass additional_data.next_cursor as cursor. The documented API token cost is 10 tokens. Output

variations.update

products.variations.update Update a product variation Risk: write
Input OAuth requires products:full. The parent product ID and product_variation_id are both required; supplied prices require price and currency. The documented API token cost is 5 tokens.
Output

Tasks

create

tasks.create Create a task in a project Risk: write
Input OAuth requires projects:full. The Tasks endpoints are marked beta by Pipedrive. title and project_id are required; done and milestone use 0/1 integers, and assignee_ids accepts up to 10 IDs. The documented API token cost is 5 tokens. Output

delete

tasks.delete Delete a project task and its subtasks Risk: destructive
Input OAuth requires projects:full. The Tasks endpoints are marked beta by Pipedrive. Deleting a task also deletes its subtasks. The documented API token cost is 3 tokens. Output

get

tasks.get Get a task by its numeric ID Risk: read
Input OAuth requires projects:read or projects:full. The Tasks endpoints are marked beta by Pipedrive. The response includes additional_data: null. The documented API token cost is 1 token. Output

list

tasks.list List project tasks with cursor pagination Risk: read
Input OAuth requires projects:read or projects:full. The Tasks endpoints are marked beta by Pipedrive. The limit is 1–500; pass additional_data.next_cursor as cursor. parent_task_id accepts a parent ID or null to filter root tasks. The documented API token cost is 10 tokens. Output

update

tasks.update Update a project task Risk: write
Input OAuth requires projects:full. The Tasks endpoints are marked beta by Pipedrive. The path ID is supplied as input id and omitted from the JSON body; done and milestone use 0/1 integers. The documented API token cost is 5 tokens. Output