LivingMetrics API Authentication
LivingMetrics implements the following endpoints for migration or integration with external services. All endpoints require an API key.
API Base URL: https://api.livingmetrics.com
Account Specific API Key The LivingMetrics account API key can be passed in the X-Api-Key request header field: X-Api-Key: APIKEY Or as a parameter named api-key: https://api.livingmetrics.com/?api-key=APIKEY
How To Submit Custom Fields
Custom fields can be entered in either of two formats.
Using the custom field ID custom_{id}
This requires you to know the id for the custom field that you are trying to populate. This can be found by looking up the fields configured on your account.For example if your account is configured with a custom field named "Department" with an ID of 1234 on your contact object, you can populate using the following:
| Name | List Contacts |
|---|---|
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts?page=0&limit=100&search_term=John Doe&search_list_id=123&search_tag=lead,customer&history_type=SiteVisit,EmailOpen&employer_id=456&contact_ids=1,2,3&tracked_phone_id=789&include_deals=true&crm_ids=["crm_id_1","crm_id_2"]&crm_type=salesforce&crm_object_type=Lead&order=desc&order_by=updated&created_by=YYYY-MM-DDTHH:MM:SSZ&updated_by=YYYY-MM-DDTHH:MM:SSZ&include_timeline=1 |
| Note | Retrieves a paginated list of contacts based on various filter criteria. Requires X-Api-Key header for authentication. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | page
0
Page number for pagination (default: 0)
limit
100
Number of contacts per page (default: 100, max: 500)
search_term
John Doe
Search term for full-text search across contact details.
search_list_id
123
ID of a contact list to search within.
search_tag
lead,customer
Comma-separated tags to filter contacts by.
history_type
SiteVisit,EmailOpen
Comma-separated history types to filter contacts by (e.g., SiteVisit, EmailOpen, TextMessage).
employer_id
456
ID of an employer (Account) to filter contacts by.
contact_ids
1,2,3
Comma-separated contact IDs to fetch specific contacts.
tracked_phone_id
789
ID of a tracked phone, used with history_type='TextMessage' to filter messages to/from this number.
include_deals
true
Set to 'true' to include deal information with contacts.
crm_ids
["crm_id_1","crm_id_2"]
JSON array or comma-separated string of CRM UIDs.
crm_type
salesforce
Type of CRM (e.g., salesforce, pipedrive).
crm_object_type
Lead
CRM object type (e.g., Lead, Contact).
order
desc
Order of results ('asc' or 'desc', default: 'desc').
order_by
updated
Field to order by ('updated', 'company', 'lead_score', 'visible_at' (default)).
created_by
YYYY-MM-DDTHH:MM:SSZ
Filter contacts created on or after this date.
updated_by
YYYY-MM-DDTHH:MM:SSZ
Filter contacts updated on or after this date.
include_timeline
1
Set to '1' to include the contact's timeline (last 30 history items). |
| Name | Get Contact Count |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts/count?search_term=John Doe&search_list_id=123&search_tag=lead&history_type=SiteVisit&employer_id=456&created_by=YYYY-MM-DDTHH:MM:SSZ&updated_by=YYYY-MM-DDTHH:MM:SSZ |
| Note | Retrieves the total count of contacts matching the filter criteria. Requires X-Api-Key header. |
| Headers | X-Api_Key: xxxx-xxxxx-xxxxx-xxxxx |
| Params | search_term
John Doe
Search term for full-text search.
search_list_id
123
ID of a contact list.
search_tag
lead
Tag to filter by.
history_type
SiteVisit
History type to filter by.
employer_id
456
Employer (Account) ID.
created_by
YYYY-MM-DDTHH:MM:SSZ
Filter contacts created on or after this date.
updated_by
YYYY-MM-DDTHH:MM:SSZ
Filter contacts updated on or after this date. |
| Name | Get Contact Field Definition |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts/field?field_key=emails.email_address.com/v1/contacts/field?field_key=emails.email_address |
| Note | Retrieves the definition for a specific contact field. No API key required for this endpoint. |
| Headers | X-Api_Key: xxxx-xxxxx-xxxxx-xxxxx |
| Params | field_key
emails.email_address
The API key of the field (e.g., 'emails.email_address' or 'custom_123'). |
| Name | List Contact Fields |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts/fields?data_import_id=123&powerdialer_only=1 |
| Note | Retrieves a list of available contact fields, including standard and custom fields. No API key required for this endpoint. |
| Headers | X-Api_Key: xxxx-xxxxx-xxxxx-xxxxx |
| Params | **data_import_id**
123
(Optional) ID of a data import to get mapped fields.
**powerdialer_only**
1
(Optional) Set to '1' to restrict fields to those visible in the powerdialer. |
| Name | Get Contact Details |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts/12345?include_deals=true |
| Note | Retrieves details for a specific contact. Requires X-Api-Key header. |
| Headers | X-Api_Key: xxxx-xxxxx-xxxxx-xxxxx |
| Params | **include_deals**
true
(Optional) Set to 'true' to include deal information |
| Name | Get Tasks for a Contact |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts/12345/task.json?include_completed=0&user_only=0 |
| Note | Retrieves a list of tasks associated with a specific contact. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | **include_completed**
0
Default 0. Set to 1 to include completed tasks.
**user_only**
0
Default 0. Set to 1 to restrict tasks to the authenticated user (employee). |
| Name | Get Tasks |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts/12345/tasks.json?include_completed=0&user_only=1 |
| Note | List all tasks for this contact in your account. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | **include_completed**
0
Passing 1 will include completed tasks, defaults to 0
**user_only**
1
Restrict to only show user tasks, this is forced true if the user only has permissions to see their own |
| Name | Get Organizations |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/organizations?page=0&limit=100&order=desc&order_by=created_at |
| Note | Retrieves a list of organizations associated with the authenticated account. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | **page**
0
Page number for pagination. Default: 0.
**limit**
100
Number of organizations per page. Default: 100, Max: 500.
**tags**
Comma-separated list of tag IDs to filter organizations.
**tag**
A single tag name to filter organizations.
**search_term**
Term to search across organization fields.
**order**
desc
Order of results. Values: 'asc' or 'desc'. Default: 'desc'.
**order_by**
created_at
Field to order by. Values: 'last_activity', 'updated_at', 'created_at'. Default: 'created_at'. |
| Name | Get Tasks |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/tasks.json?limit=100&page=0&include_completed=0&user_only=0 |
| Note | Retrieves a list of tasks for the authenticated account. Supports pagination and filtering. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | **limit**
100
Default 100, max 500. Number of tasks to return per page.
**page**
0
Default 0. Page number for pagination.
**include_completed**
0
Default 0. Set to 1 to include completed tasks.
**user_only**
0
Default 0. Set to 1 to restrict tasks to the authenticated user (employee). This is forced true if the user only has permissions to see their own tasks.
**contact_id**
(Optional) Filter tasks by a specific contact ID. |
| Name | Get Task |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/tasks/12345.json |
| Note | Retrieves details for a single task by its ID. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | |
| Name | Get Tasks for a Contact |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/tasks/contact/12345.json?include_completed=0&user_only=0 |
| Note | Retrieves a list of tasks associated with a specific contact. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | **include_completed**
0
Default 0. Set to 1 to include completed tasks.
**user_only**
0
Default 0. Set to 1 to restrict tasks to the authenticated user (employee). |
| Name | Get Task Outcomes |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/tasks/outcomes.json |
| Note | Retrieves a list of available task outcomes for the account. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | |
| Name | Get Task Types |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/tasks/types.json |
| Note | Retrieves a list of available task types for the account. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | |
| Name | Get Task Statuses |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/tasks/statuses.json |
| Note | Retrieves a list of available task statuses for the account. |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | |
| Name | Get Histories |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/histories?page=0&limit=100&history_type=&campaign_id=12345&contact_id=12345&start_date=&end_date=&last_history_id=&contact_group=emailed&search_term&order=asc&email_guid&tracked_number_id |
| Note | This endpoint will return contact histories matching the given parameters |
| Headers | X-Api_Key: xxxxx-xxxxx-xxxxx-xxxxx |
| Params | **page**
0
Default 0
**limit**
100
Default 100, max 500
**history_type**
Contact History Type
**campaign_id**
12345
Campaign ID
**contact_id**
12345
Contact ID
**start_date**
Start Date
**end_date**
End Date
**last_history_id**
**contact_group**
emailed
Values are "all", "managed" and "emailed". The default is "emailed"
**search_term**
Search term
**order**
asc
Values are "asc" or "desc". The default is "desc"
**email_guid**
Email GUID
**tracked_number_id**
Return all text messages associated with this tracked number if history_type = TextMessage |
| Name | Get Static Contact Lists |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contact_lists?page=0&limit=10&tag=&order=&order_by= |
| Note | Get all the static contact lists that are visible for sales users for the current account |
| Headers | X-Api_Key: xxxx-xxxx-xxxx-xxxx
Content-Type: application/json |
| Params | **page**
0
Current page of resulting contact lists
**limit**
10
Total number of results
**tag**
"PowerDialer" - will return on PowerDialer contact lists
**order**
asc or desc, defaults to desc
**order_by**
can be created, or updated and defaults to created |
| Name | List Products (Units) |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/products?limit=100&page=0 |
| Note | Retrieves a list of products, ordered by creation date in descending order. Supports pagination with limit and page. |
| Headers | X-Api_Key: xxxx-xxxx-xxxx-xxxx
Content-Type: application/json |
| Params | **limit**
100
Number of products to return (Max: 500, Default: 100)
**page**
0
Page for pagination (Default: 0) |
| Name | Get Product by ID |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/products/12345 |
| Note | Retrieves a specific product by its ID. |
| Headers | X-Api-Key: xxxx-xxxx-xxxx-xxxx
X-Api_Key: xxxx-xxxx-xxxx-xxxx
Content-Type: application/json |
| Params | |
| Name | Get Product Statuses |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/products/statuses |
| Note | Retrieves a list of available product statuses for the account. |
| Headers | X-Api_Key: xxxx-xxxx-xxxx-xxxx
Content-Type: application/json |
| Params | |
| Name | Get Prospects |
| Function | GET |
| cURL | https://api.livingmetrics.com/v1/contacts?page=0&limit=10&include_deals=true&order=desc&order_by=updated&include_timeline=0 |
| Note | Retrieves a list of Prospects |
| Headers | |
| Params |