These functions are for interacting with the individual pipeline items attached to contacts. If you're wanting to interact with the structure of the pipelines themselves, you'll want to check out the Pipelines functions.
This function creates a pipeline item attached to a contact or company.
The id of the contact this pipeline item will be attached to.
The id of the pipeline this pipeline item should be added to.
The id of the status where this pipeline item should be placed.
You can optionally add a note to this pipeline item, which will show up in the history for this pipeline item.
This function edits a pipeline item attached to a contact or company.
This function deletes an existing pipeline item.
The Id of the pipeline item you want to delete.
This function retrieves a single pipeline item based on the Id of the pipeline item. If you don't already know the
PipelineItemId you can
find pipeline items using
The id of the pipeline item to get.
This function searches all the pipeline items on your account.
The pipeline item you'd like to return pipeline items for.
If you'd like to only see pipeline items entered by specific users, pass their UserIds into this field and we'll filter the results to only show those users' pipeline items (based on the contact they are attached to). Passing an empty array will return results for all users whose contacts you have read access to.
If you'd like to see pipeline items in a certain set of statuses, you can pass in the StatusId into this field we'll filter the results to only show pipeline items in those statuses. An empty array or NULL value will return all active statuses by default.
Which field to sort by; by default, will use status.
Direction for sort order.
How many results should be returned from a single API call? The max value is 10,000. If you need to return
more results, call this API function again, but increment the
If there are more results than
MaxNumberOfResults, you can call this function again with an incremented
Page value to get the next page of results. For example, if there are 700 results, but you're only requesting
500 at a time, you could call this function with Page=2 to get the remaining 200 results.
This function retrieves all the pipeline items attached to a given contact.
The id of the contact to get pipeline items for.