API Reference

Authentication

OpenInbound is using Basic authentication. Use your API Key as the password.

API Endpoints

Contact
HTTP method Endpoint Function
GET /api/v1/contact

Query contacts

Parameters:

limit=100
returncount=1|0
email=(any email address)
search={search string}
email_set=1|0
GET /api/v1/contact/{id} Get a contact
POST /api/v1/contact/{id} Update a contact
     
Event
POST api/v1/event Create a new event. The contact_id always need to be set.

 

Newsletter