Explore
Introduction
MLabs V3's REST APIs makes it incredibly easy to integrate V3's capabilities into your website, databases, and internal processes. These APIs are primarily used for server-side integration (i.e., Java, PHP, Ruby, etc.), but they can also be used for client-side integration via the JavaScript API Wrapper (albeit in a somewhat more limited fashion).
To access any of the REST API resources, use the following URL:
http://[YOUR_CLIENT_ID].mobilizationlabs.com/api/3.0/
You can find your Client ID on the Platform Config page of your V3 Staff App. Also, most API resources require an API key, which you will also find in Platform Config. Never give your API key to anyone, and never expose it client-side!
Available API Methods
Click a method below to explore details.
Platform Config
No methods available
| GET | Get information about all the configured interests |
|
| GET | Get general information and statistics about your platform |
Authentication
No methods available
| POST | Log a supporter out of Engage Anywhere |
|
| POST | Log a supporter into Engage Anywhere |
Actions
No methods available
| GET | Get the Actions assigned to a supporter's record |
Teams/Groups
No methods available
| GET | Get the list of teams or groups |
|
| POST | Join a supporter to a team or group |
|
| GET | Get the list of teams/groups connected to a supporter's record |
Tasks
No methods available
| POST | Update progress for or complete a task. |
|
| GET | Get information about a task |
|
| POST | Update progress for or complete a task |
Supporter Profiles
No methods available
| POST | Add tags to a supporter's record |
|
| GET | Get a list of tags from a supporter's record |
|
| DELETE | Delete specific tags from a supporter's record |
|
| POST | Add a phone number to a supporter's record |
|
| GET | Get a list of phone numbers from a supporter's record |
|
| DELETE | Delete a phone number from a supporter's record |
|
| POST | Add a note to a supporter's record |
|
| POST | Add interests to a supporter's profile |
|
| GET | Get the list of a supporter's involvement interests |
|
| DELETE | Delete an interest from a supporter's record |
|
| POST | Add friends to a supporter's record |
|
| GET | Get the list of a supporter's friends |
|
| POST | Add an address to a supporter's record |
|
| GET | Get addresses from a supporter's record |
|
| DELETE | Delete an address from a supporter's record |
|
| POST | Add an activity to a supporter's feed |
|
| GET | Get the activity feed of a supporter's record |
|
| POST | Add information to a supporter's profile |
|
| GET | Get a supporter's profile data |
|
| GET | Search for supporters by email address or proprietary ID |
|
| POST | Add a new supporter |
|
| GET | Get the list of supporters |
Donations
No methods available
| POST | Add a donation. Requires HTTPS. |
|
| GET | Get donation entries |
Miscellaneous