Leadsopedia API allows you to access and build your own application that interact with Leadsopedia Features. Our API provides a RESTful interface with JSON-formatted responses to access most resources. By using the following endpoint: api.leadsopedia.com, There is only one current versions of the API that covers the functionality of the system at the moment and we are continuously working on expanding our API functionality, so stay tuned!
To access the API, you need the API key located under Settings - API Key. Example of the API key: AKp2BbuyfS-ugPMkBmd3sg2
All API request URLs start with https://api.leadsopedia.com/v1
For example, to make a request to get the list of contacts in your account, you need to append the people index path to the base URL to form a URL that looks like https://api.leadsopedia.com/contacts
Location
header returned contains the URL to the newly-created item.
ApiKey
.
ApiKey
doesn't have access to the requested resource.
Each Reply user has a limit of 15,000 API calls per month.
The time limit between API calls takes 10 seconds.
The limit for syncing contacts using native integrations is the same as the limit for the number of contacts in your Reply account.
curl https://api.leadsopedia.com/v1/contacts \
-H 'X-Api-Key: AKp2BbuyfS-ugPMkBmd3sg2'
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' }
const url = 'https://api.leadsopedia.com/v1/contacts';
axios.get(url, { headers })
.then(({ data }) => {
// list of contacts
console.log(data);
})
.catch(error => {
console.error(error);
});
GET
Lists
GET /mylists
returns a list of all mylists in your leadsopedia account.
lists
array
- array of lists
total
int
- total people count
page
int
- current page
limit
int
- page size. Default value is 100
pagesCount
int
- total number of pages with current limit
next
string
- link for next page with current limit
previous
string
- link to previous page with current limit
x-api-key : {your_api_key}
GET
List (By ID)
GET /mylists/{list_id}
returns list details from a leadsopedia account
id
string
- list's ID
name
string
- list name
total_contacts
int
- total number of contacts in the list
date_created
datetime
- date when list is created
x-api-key : {your_api_key}
POST
Create List
POST /mylists
add lists or updates if they already exist.
name
string | required
Content-Type : application/json
x-api-key : {your_api_key}
POST
Update List
POST /mylists/{list_id}
updates the list by ID. ID is required and needs to be passed into the request body
DEL
Delete List
DELETE /mylists/{id}
deletes the list by their ID
x-api-key : {your_api_key}
// Get all lists
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/mylists';
axios.get(url, { headers })
.then(({ data }) => {
// array of lists
console.log(data.lists);
// total people count
console.log(data.count)
// current page
console.log(data.page)
// page size
console.log(data.limit)
// total number of pages
console.log(data.pagesCount)
// link to next page
console.log(data.next)
// link to previous page
console.log(data.previous)
}).catch(error => console.error(error));
// --------------------------------------------------------
// Get list by ID
const axios = require('axios');
const listID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/mylists/${listID}`;
axios.get(url, { headers })
.then(({ data }) => {
// list ID
console.log(data.id);
// list name
console.log(data.name);
// total contacts in list
console.log(data.total_contacts)
// date list was created
console.log(data.date_created)
}).catch(error => console.error(error));
// --------------------------------------------------------
// Create list
const axios = require('axios');
const headers = {
'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2',
'Content-Type': 'application/json',
};
const url = 'https://api.leadsopedia.com/v1/mylists';
const data = {
name: 'My List',
};
axios.post(url, data, { headers })
.then((response) => {
if(response.status === 201) {
console.log('List created.');
}
}).catch(error => console.error(error));
// --------------------------------------------------------
// Update list by ID
const axios = require('axios');
const listID = 1;
const headers = {
'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2',
'Content-Type': 'application/json',
};
const url = `https://api.leadsopedia.com/v1/mylists/${listID}`;
const data = {
name: 'My Other List',
};
axios.post(url, data, { headers })
.then((response) => {
console.log('List updated.');
})
.catch(error => console.error(error));
// --------------------------------------------------------
// Delete list by ID
const axios = require('axios');
const listID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/mylists/${listID}`;
axios.delete(url, {}, { headers })
.then(() => console.log('List deleted.'))
.catch(error => console.error(error));
GET
Contacts
GET /contacts
return list of all contacts from selected list in your leadsopedia account.
contacts
array
- array of contacts in a list
total
int
- total contacts count
page
int
- current page
limit
int
- page size. Default is 100
pagesCount
int
- total number of pages with current limit
next
string
- link for next page with current limit
previous
string
- link to previous page with current limit
x-api-key : {your_api_key}
GET
Contacts (By Email)
GET /contacts/{list_id}
return list details from leadsopedia account.
id
int
- contact's ID
email
string
- contact's email
first_name
string
- contact's first name
last_name
string
- contact's last name
title
string
- contact's title
company
string
- contact's company
phone
string
- contact's phone number
city
string
- contact's city
state
string
- contact's state
region
string
- contact's region
country
int
- contact's country
date_added
datetime
- date contact was added
GET
Contacts (By ID)
GET /contacts/{list_id}?id={contact_id}
return list details from leadsopedia account.
id
int
- contact's ID
email
string
- contact's email
first_name
string
- contact's first name
last_name
string
- contact's last name
title
string
- contact's title
company
string
- contact's company
phone
string
- contact's phone number
city
string
- contact's city
state
string
- contact's state
region
string
- contact's region
country
int
- contact's country
date_added
datetime
- date contact was added
POST
Add List Contact
POST
Update List Contact (By Email)
DEL
Delete Contact (By ID)
DELETE /contacts/{list_id}?id={contact_id}
deletes the list contact by their ID.
DEL
Delete Contact (By Email)
// Get all contacts
const axios = require('axios');
const listID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/contacts`;
axios.get(`${url}?list_id=${listID}`, { headers })
.then(({ data }) => {
// array of contacts
console.log(data.contacts);
// total people count
console.log(data.count)
// current page
console.log(data.page)
// page size
console.log(data.limit)
// total number of pages
console.log(data.pagesCount)
// link to next page
console.log(data.next)
// link to previous page
console.log(data.previous)
}).catch(error => console.error(error));
// --------------------------------------------------------
// Get contacts by Email
const axios = require('axios');
const contactID = 1;
const listID = 1;
const email = 'email@example.com';
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/contacts`;
axios.get(`${url}?list_id=${listID}&email=${email}`, {
headers
})
.then(({ data }) => {
console.log(data.id);
console.log(data.email);
console.log(data.first_name);
console.log(data.last_name);
console.log(data.title);
console.log(data.company);
console.log(data.phone);
console.log(data.city);
console.log(data.state);
console.log(data.region);
console.log(data.country);
console.log(data.date_added);
}).catch(error => console.error(error));
// --------------------------------------------------------
// Get contact by ID
const axios = require('axios');
const contactID = 1;
const listID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/contacts`;
axios.get(`${url}?list_id=${listID}&id=${listID}`, {
headers
})
.then(({ data }) => {
console.log(data.id);
console.log(data.email);
console.log(data.first_name);
console.log(data.last_name);
console.log(data.title);
console.log(data.company);
console.log(data.phone);
console.log(data.city);
console.log(data.state);
console.log(data.region);
console.log(data.country);
console.log(data.date_added);
}).catch(error => console.error(error));
// --------------------------------------------------------
// Create contact
const axios = require('axios');
const headers = {
'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2',
'Content-Type': 'application/json',
};
const url = 'https://api.leadsopedia.com/v1/contacts';
const data = {};
axios.post(url, data, { headers })
.then((response) => {
if(response.status === 201) {
console.log('Contact created.');
}
}).catch(error => console.error(error));
// --------------------------------------------------------
// Update contact by ID
const axios = require('axios');
const contactID = 1;
const headers = {
'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2',
'Content-Type': 'application/json',
};
const url = `https://api.leadsopedia.com/v1/contacts/${contactID}`;
const data = {};
axios.post(url, data, { headers })
.then((response) => {
console.log('Contact updated.');
})
.catch(error => console.error(error));
// --------------------------------------------------------
// Delete contact by ID
const axios = require('axios');
const contactID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/contacts/${contactID}`;
axios.delete(url, {}, { headers })
.then(() => console.log('Contact deleted.'))
.catch(error => console.error(error));
// --------------------------------------------------------
// Delete contact by Email
const axios = require('axios');
const email = 'email@example.com';
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/contacts?email=${email}`;
axios.delete(url, {}, { headers })
.then(() => console.log('Contact deleted.'))
.catch(error => console.error(error));
GET
Downloads
GET /downloads
return all downloads from your leadsopedia account.
downloads
array
- array of downloads
total
int
- total downloads count
page
int
- current page
limit
array
- page size. Default value is 100
pagesCount
int
- total number of pages with current limit
next
string
- link for next page with current limit
x-api-key : {your_api_key}
GET
Download (By ID)
GET /downloads/{id}
return all download details from your leadsopedia account.
id
int
- download ID
filename
string
- download file name
extension
string
- download file extension
url
string
- download link of a file
date_created
datetime
- when download was created
x-api-key : {your_api_key}
DEL
Download (By ID)
DELETE /downloads/{id}
deletes download by their ID.
x-api-key : {your_api_key}
// Get all downloads
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/mydownloads';
axios.get(url, { headers })
.then(({ data }) => {
// array of downloads
console.log(data.downloads);
// total people count
console.log(data.count)
// current page
console.log(data.page)
// page size
console.log(data.limit)
// total number of pages
console.log(data.pagesCount)
// link to next page
console.log(data.next)
// link to previous page
console.log(data.previous)
}).catch(error => console.error(error));
// --------------------------------------------------------
// Get download by ID
const axios = require('axios');
const downloadID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/mydownloads/${downloadID}`;
axios.get(url, { headers })
.then(({ data }) => {
console.log(data.id);
console.log(data.filename);
console.log(data.extension);
console.log(data.url);
console.log(data.date_created);
}).catch(error => console.error(error));
// --------------------------------------------------------
// Delete download by ID
const axios = require('axios');
const downloadID = 1;
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = `https://api.leadsopedia.com/v1/mydownloads/${downloadID}`;
axios.delete(url, {}, { headers })
.then(() => console.log('Download deleted.'))
.catch(error => console.error(error));
GET
Account
GET /account
return details of your leadsopedia account.
id
int
- account ID
name
string
- account name
address
string
- account address
phone
string
- account phone number
email
string
- registered account email
company
string
- company name
status
string
- account status
date_created
datetime
- when account was created
x-api-key : {your_api_key}
GET
Account Credits Status
GET /account/credits
return credits status of your leadsopedia account.
credits_total
int
- total credits received from start
credits_used
int
- total credits used
credits_left
int
- total credits left
x-api-key : {your_api_key}
GET
Account Usages Status
GET
Account Activity
GET /account/activity
return activities of your leadsopedia account.
activities
array
- array of activities
total
int
- total activities count
page
int
- current page
limit
int
- page size. Default value is 100
pagesCount
int
- total number of pages with current limit
next
int
- link to next page with current limit
previous
int
- link to previous page with current limit
GET
Account History
GET /account/history
return search history of your leadsopedia account.
history
array
- array of history
id
ObjectID
- id of search history
type
string
- search type (contacts, company, email)
lead_count
int
- total leads found from search
date_added
datetime
- when search was added
total
int
- total history count
page
int
- current page
limit
int
- page size. Default value is 100
pagesCount
int
- total number of pages with current limit
next
int
- link to next page with current limit
previous
int
- link to previous page with current limit
// Get account
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/account';
axios.get(url, { headers })
.then(({ data }) => {
console.log(data.id);
console.log(data.name);
console.log(data.address);
console.log(data.email);
console.log(data.company);
console.log(data.status);
console.log(data.date_created);
}).catch(error => console.error(error));
// --------------------------------------------------------
// Get account credits status
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/account/credits';
axios.get(url, { headers })
.then(({ data }) => {
console.log(data.credits_total);
console.log(data.credits_used);
console.log(data.credits_left);
})
.catch(error => console.error(error));
// --------------------------------------------------------
// Get account usage status
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/account/usage';
axios.get(url, { headers })
.then((response) => console.log(response.data))
.catch(error => console.error(error));
// --------------------------------------------------------
// Get account activity
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/account/activity';
axios.get(url, { headers })
.then(({ data }) => {
console.log(data.activities);
console.log(data.total);
console.log(data.page);
console.log(data.limit);
console.log(data.pagesCount);
console.log(data.next);
console.log(data.previous);
})
.catch(error => console.error(error));
// --------------------------------------------------------
// Get account history
const axios = require('axios');
const headers = { 'X-Api-Key': 'AKp2BbuyfS-ugPMkBmd3sg2' };
const url = 'https://api.leadsopedia.com/v1/account/history';
axios.get(url, { headers })
.then(({ data }) => {
console.log(data.history);
console.log(data.total);
console.log(data.page);
console.log(data.limit);
console.log(data.pagesCount);
console.log(data.next);
console.log(data.previous);
})
.catch(error => console.error(error));
Please enter your E-Mail address to get updated by our newsletter!