The Locable API is organized around REST and returns JSON Responses.
Contact the Locable Support team to request your API key.
The Locable API uses API keys to authenticate requests. You can view and manage your API keys in your Locable Account by going to Account Settings > API Keys.
NOTE: All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Example Request:curl -H "X-API-Key: YOUR_API_KEY" https://impact.locable.com/api/v1/events
Example Response:{
"status": "success",
"message": "",
"events": [
{
"event_id": 40415,
"title": " A Main Street or Downtown Website That Delivers: Key Elements for Engagement and Impact",
"subtitle": "",
"description": "<p><span style=\"color: inherit;\">Whether you're considering a new website, aiming to enhance your existing site, or simply want to avoid costly and time-consuming mistakes, our upcoming webinar is tailored for you. </span></p><p><span style=\"color: inherit;\">This session is designed to help staff and board members alike understand how to make their online efforts more effective, engaging, and efficient. By participating, you'll learn not only to manage your web presence better but also to connect more deeply with the community you serve.</span></p><p><strong>Here's what we'll cover in the webinar:</strong></p><ul><li><strong>More Engaging and Accessible Websites:</strong> Tips on making your website more user-friendly and accessible to all... and avoid potential legal (yes, legal) issues.</li><li><strong>Streamlined Content Management:</strong> Strategies for quick and easy updates that keep your site fresh and relevant along with the roll of content to highlight your community's assets and become more inclusive.</li><li><strong>Effective Use of Social Media:</strong> Techniques for leveraging social media to increase reach and engagement.</li><li><strong>Integration of Email Newsletters:</strong> Insights into how email can be a powerful tool for keeping the community informed and engaged.</li><li><strong>Cross-Promotion Strategies:</strong> Methods for collaborating with local businesses and partners to boost your online presence.</li></ul><p><strong>For Board Members:</strong></p><p>Your participation in this webinar will equip you with the knowledge to oversee strategic web initiatives more effectively, ensuring our digital efforts align with our organizational goals. You'll learn about the latest in web compliance and efficiency, which are crucial for maintaining our organization's reputation and operational effectiveness.</p><p>Don’t miss this opportunity to transform how you manage your online presence and engage with the community. </p><p><a href=\"https://us02web.zoom.us/webinar/register/WN_ZeHduHqATJadA-MWV9ztyA\" target=\"_blank\">Sign up now</a> to secure your spot in this transformative webinar and take a significant step toward enhancing your marketing impact, website capabilities, and community engagement.</p><h3>Want live feedback on your website?</h3><p>Complete this 2-minute questionnaire and we'll provide real-time feedback on your website during the webinar.</p>",
"meta_description": "Ensure your main street website is reaching it's potential with our webinar on structure, content, and strategic goals - we include plenty of examples.",
"type": "Event",
"published": true,
"start_date": "2024-05-15",
"start_time": "12:00 PM CDT",
"end_time": "12:45 PM CDT",
"time_zone": "America/Chicago",
"repetition": "",
"end_date": null,
"upcoming_occurences": [
{
"date": "2024-05-15",
"canonical_url": "//www.locable.com/2024/05/15/197222/a-main-street-or-downtown-website-that-delivers-key-elements-for-engagement-and-impact"
}
],
"virtual": true,
"location": {},
"price": "Free",
"url": "https://us02web.zoom.us/webinar/register/WN_ZeHduHqATJadA-MWV9ztyA",
"ticket_url": "",
"facebook_url": "",
"phone": null,
"image": "//impact-production.s3.amazonaws.com/_originals/6cead22d-5004-47bc-be6b-9ad408b086b2/Main Street Website Sitemap Template.png",
"event_categories": [
{
"category_id": 2344,
"category_name": "Main Streets"
},
{
"category_id": 1869,
"category_name": "Anchors"
}
]
}
],
"pagination": {
"previous_page": null,
"next_page": null,
"total_pages": 1,
"current_page": 1
}
}
Pagination
Results are paginated and the response will include information about the current page, previous/next page, and total pages available as shown below:"pagination": {
"previous_page": null,
"next_page": null,
"total_pages": 1,
"current_page": 1
}
Example Request:curl -H "X-API-Key: YOUR_API_KEY" https://impact.locable.com/api/v1/events?page=2
Endpoints
- GET /api/v1/events