👋 Welcome to Platformly.com API Documentation
With Platformly API, you can:
- Manage your Contacts within your Platformly CRM
- Fetch different Data & Reports information
- Fire Events and track your contacts behavior
Dig into our documentation to Get Started. The Platformly api has you covered with everything you need from an interactive API explorer, code samples in your favorite languages and comprehensive examples.
Getting Started
The API Documentation contains Articles that are linked and used in the API Examples. Those articles contain important information about the API.
Every request needs to contain an API Key for authentication. To learn more about the API Key navigate to the "How to Obtain an API Key" Section.
The API accepts a POST request method which has to contain the following data parameters:
action -> Action/Method that is being requested
value -> Additional (JSON Formatted) data required based on the requested "action"
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP are automatically redirected. API requests without authentication will also fail.
Errors
Platformly uses conventional HTTP response codes to indicate the success or failure of an API request.
In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter is missing, the contact doesn't exist, etc.).
Codes in the 5xx range indicate an error with Platformly's servers (these are rare).
FAQs
Some of the most asked questions from Developers when dealing with our API.
What is the API Limit?
The API Limit is 5 req/sec per user account.
Why I'm receiving a 404/Not Found Missing Parameters Error
This error means that one of the main parameters was not properly sent or it is using a bad format. Please make sure the following parameters are available: api_key, action, value.
We're Here to Help
Get in touch and let us know how we can help.
Contact our team by filling the form to get help from our team of in-house experts.