Less Annoying CRM logo Less Annoying CRM LACRM
API Documentation
Getting Started
Core API Functions
Settings Functions
Advanced
Core API Functions

Items attached to contacts

This API allows you to interact with many different record types, but everything centers around contacts. A common use case is to want to get all of the things attached to a contact, so we collected all of those functions in one place to make your life easier.

All of these functions exist elsewhere in the API docs. For example, GetEventsAttachedToContact is also listed under the "Events" documentation.

Get contact relationships

This function returns all of the relationships for a specific contact. Relationships are bi-directional, so this will include relationships where the contact is listed as Contact1 or Contact2.

How to call this function
Function name
GetRelationshipsAttachedToContact
Parameters
ContactId Uid Required

The id of the contact whose relationships you want to get.

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.

Expand
Response
{
"HasMoreResults": false,
"Results": [
{
"RelationshipId": "3952673865447632872054233767944",
"ContactId1": "3952673865447632872054233458726",
"ContactId2": "3952673865447632872054232174231",
"Note": "John and Jane are married",
"CreatedBy": "123",
"DateCreated": "2024-04-26T23:23:56-07:00",
"DateEdited": "2024-04-26T23:23:56-07:00",
"Contact1MetaData": {
"Name": "John Doe"
}
"Contact2MetaData": {
"Name": "Jane Doe"
}
"CreatedByMetaData": {
"FirstName": "Your",
"LastName": "Name"
}
},
{...},
{...}
]
}
Expand

Get contact events

Returns all events for a contact.

How to call this function
Function name
GetEventsAttachedToContact
Parameters
ContactId Uid Required

The contact to get events for.

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.

Expand
Response
{
"HasMoreResults": false,
"Results": [
{
"EventId": "3952673865459162087100301468955",
"Name": "",
"StartDate": "2024-04-26T23:23:56-07:00",
"EndDate": "2024-04-26T23:23:56-07:00",
"Location": "",
"Description": "",
"IsAllDay": false,
"IsRecurring": false,
"RecurrenceEventId": "3952673865459162087100300749874",
"RecurrenceRule": "",
"EndRecurrenceDate": "2024-04-26T23:23:56-07:00",
"SeriesNumber": 10,
"DateCreated": "2024-04-26T23:23:56-07:00",
"DateUpdated": "2024-04-26T23:23:56-07:00",
"ContactIds": [
"3952673865459162087100301399688",
"3952673865459162087100300557731",
"3952673865459162087100302213539"
],
"UserIds": [
"3952673865459162087100302084345",
"3952673865459162087100301794094",
"3952673865461467930109515744747"
],
"Attendees": [
{
"IsUser": false,
"AttendeeId": "3952673865461467930109515220482",
"AttendanceStatus": ""
},
{...},
{...}
]
"CalendarId": "3952673865461467930109515072915",
"ContactMetaData": [
{
"Name": "John Doe",
"AssignedTo": "123456"
},
{...},
{...}
]
"UserMetaData": [
{
"FirstName": "Your",
"LastName": "Name"
},
{...},
{...}
]
"CalendarMetaData": {
"Name": "Primary calendar"
}
},
{...},
{...}
]
}
Expand

Get contact tasks

Returns all tasks for a contact.

How to call this function
Function name
GetTasksAttachedToContact
Parameters
ContactId Uid Required

The contact to get tasks for.

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.

Expand
Response
{
"HasMoreResults": false,
"Results": [
{
"TaskId": "3952673865466079616127941862727",
"Name": "Follow-up with John",
"DueDate": "2024-05-03",
"AssignedTo": "3952673865466079616127941530333",
"Description": "We talked yesterday but they were busy and said to touch base next week.",
"ContactId": "3952673865468385459137155308742",
"IsCompleted": false,
"DateCompleted": "2024-04-26T07:23:56-07:00",
"CalendarId": "3952673865468385459137155594502",
"DateCreated": "2024-04-26T23:23:56-07:00",
"AssignedToMetaData": {
"FirstName": "Your",
"LastName": "Name"
}
"ContactMetaData": {
"Name": "John Doe",
"AssignedTo": "123456"
}
},
{...},
{...}
]
}
Expand

Get contact pipeline items

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

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.
How to call this function
Function name
GetPipelineItemsAttachedToContact
Parameters
ContactId Uid Required

The id of the contact to get pipeline items for.

Expand
Response
[
{
"PipelineId": "3853178701634960990616937360520",
"PipelineItems": [
{
"PipelineItemId": "3952673865472997145155582565312",
"PipelineId": "3853178701634960990616937360520",
"StatusId": "3952673865472997145155583806372",
"ContactId": "3952673865472997145155582732659",
"LastUpdate": "2024-04-26T23:23:56-07:00",
"LastUpdatedBy": "3952673865475302988164796287889",
"NumberOfUpdates": 10,
"LastNote": "",
"PipelineMetaData": {
"Name": "Sales Leads"
}
"StatusMetaData": {
"Name": "Prospect"
}
"ContactMetaData": {
"Name": "John Doe",
"AssignedTo": "123456"
}
},
{...},
{...}
]
},
]
Expand

Get contact notes

Returns all notes for a contact.

How to call this function
Function name
GetNotesAttachedToContact
Parameters
ContactId Uid Required

The contact to get notes for.

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.

Expand
Response
{
"HasMoreResults": false,
"Results": [
{
"NoteId": "3952673865482220517192439004792",
"ContactId": "3952673865482220517192439035999",
"UserId": "123",
"DateCreated": "2024-04-26T23:23:56-07:00",
"DateDisplayedInHistory": "2024-04-26T23:23:56-07:00",
"Note": "I called and got their voicemail. I'll try again next week.",
"ContactMetaData": {
"Name": "John Doe",
"AssignedTo": "123456"
}
"UserMetaData": {
"FirstName": "Your",
"LastName": "Name"
}
"PipelineInfo": {
"PipelineId": "3952673865482220517192438371810",
"PipelineItemId": "3952673865484526360201652660097",
"StatusId": "3952673865484526360201652550491",
"PreviousStatusId": "3952673865484526360201653043242",
"PipelineMetaData": {
"Name": "Sales Leads"
}
"StatusMetaData": {
"Name": "Prospect"
}
}
"IsRichText": false
},
{...},
{...}
]
}
Expand