Less Annoying CRM logo Less Annoying CRM LACRM
Core API Functions

Pipeline Items

Create a pipeline item

This function creates a pipeline item attached to a contact or company.

How to call this function
Function name
CreatePipelineItem
Parameters
Note: Because fields can be customized, they're different on every account. This documentation shows fields for an example LACRM account. Please log in to see the fields for your specific account.
Showing fields for the
pipeline.
ContactId Uid Required

The id of the contact this pipeline item will be attached to.

PipelineId Uid Required

The id of the pipeline this pipeline item should be added to.

StatusId Uid Required

The id of the status where this pipeline item should be placed.

Note Text

You can optionally add a note to this pipeline item, which will show up in the history for this pipeline item.

Response
{
"PipelineItemId": "3862518547679804978905197428882"
}

Edit a pipeline item

This function edits a pipeline item attached to a contact or company.

How to call this function
Function name
EditPipelineItem
Parameters
Note: Because fields can be customized, they're different on every account. This documentation shows fields for an example LACRM account. Please log in to see the fields for your specific account.
Showing fields for the
pipeline.
PipelineItemId Uid Required

The id of the pipeline item to edit.

StatusId Uid

The id of the status where this pipeline item should be placed.

Note Text

You can optionally add a note to this pipeline item, which will show up in the history for this pipeline item.

Response
This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Delete a pipeline item

This function deletes an existing pipeline item.

How to call this function
Function name
DeletePipelineItem
Parameters
PipelineItemId Uid Required

The Id of the pipeline item you want to delete.

Response
This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Get a pipeline item

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 GetPipelineItems or GetPipelineItemsAttachedToContact.

How to call this function
Function name
GetPipelineItem
Parameters
Note: Because fields can be customized, they're different on every account. This documentation shows fields for an example LACRM account. Please log in to see the fields for your specific account.
Showing fields for the
pipeline.
PipelineItemId Uid Required

The id of the pipeline item to get.

Response
{
"PipelineItemId": "3862518547689028350942052524311",
"PipelineId": "3853178701634960990616937360520",
"StatusId": "3862518547689028350942051935297",
"ContactId": "3862518547691334193951265784918",
"LastUpdate": "2023-01-30T09:40:00-08:00",
"PipelineMetaData": {
"Name": "Sales Leads"
}
"StatusMetaData": {
"Name": "Prospect"
}
"ContactMetaData": {
"Name": "John Doe"
}
}

List all pipeline items

This function searches all the pipeline items on your account.

How to call this function
Function name
GetPipelineItems
Parameters
Note: Because fields can be customized, they're different on every account. This documentation shows fields for an example LACRM account. Please log in to see the fields for your specific account.
Showing fields for the
pipeline.
PipelineId Uid Required

The pipeline item you'd like to return pipeline items for.

UserFilter Array of Uids Default: Array

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.

StatusFilter Array of Uids Default: Array

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.

SortDirection Enum Default: Ascending
Valid options: Ascending, Descending

By default, the report will be sorted by status.

MaxNumberOfResults Number Default: 500

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 Page parameter.

Page Number Default: 1

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.

Response
{
"HasMoreResults": false,
"Results": [
{
"PipelineItemId": "3862518547695945879969692158687",
"PipelineId": "3853178701634960990616937360520",
"StatusId": "3862518547695945879969693680286",
"ContactId": "3862518547695945879969692359337",
"LastUpdate": "2023-01-30T09:40:00-08:00",
"PipelineMetaData": {
"Name": "Sales Leads"
}
"StatusMetaData": {
"Name": "Prospect"
}
"ContactMetaData": {
"Name": "John Doe"
}
},
{...},
{...}
]
}

Get contact pipeline items

This function retrieves all the pipeline items attached to a given contact.

How to call this function
Function name
GetPipelineItemsAttachedToContact
Parameters
Note: Because fields can be customized, they're different on every account. This documentation shows fields for an example LACRM account. Please log in to see the fields for your specific account.
Showing fields for the
pipeline.
ContactId Uid Required

The id of the contact to get pipeline items for.

Response
[
{
"PipelineId": "3853178701634960990616937360520",
"PipelineItems": [
{
"PipelineItemId": "3862518547702863408997333444152",
"PipelineId": "3853178701634960990616937360520",
"StatusId": "3862518547702863408997333110626",
"ContactId": "3862518547705169252006546951323",
"LastUpdate": "2023-01-30T09:40:00-08:00",
"PipelineMetaData": {
"Name": "Sales Leads"
}
"StatusMetaData": {
"Name": "Prospect"
}
"ContactMetaData": {
"Name": "John Doe"
}
},
{...},
{...}
]
},
]
Next page: Relationships