API

Integration with the EmailLabs API

EmailLabs provides a modern REST API that allows external systems to integrate with the EmailLabs infrastructure. The API is designed according to the JSONAPI specification, ensuring clarity and intuitiveness. The API documentation is generated based on a Swagger file compliant with the OpenAPI 3.0.2 standard.

General API Functionality

• Communication Format: The API supports and returns data exclusively in JSON format. All requests must be sent with the header Content-Type: application/json.

• Response Schema: All responses returned by the API have a unified structure:

{
	"meta": {
   	    "numberOfErrors": 0,
   	    "numberOfData": 1,
   	    "status": 200,
   	    "uniqId": "12345-abcde-67890",
   	    "someField": "optional_value"
	},
	"data": [],
	"errors": [
   	    {
       	        "title": "Error",
       	        "message": "Error description",
       	        "code": "ERROR_CODE",
       	        "meta": {
           	    "parameter": "parameter_name",
           	    "value": "parameter_value",
          	    "source": "error_source"
        	    }
    	    }
	]
}

API Authentication

The EmailLabs API requires authentication using two keys:

• Application-Key – The application key.

• Authorization – The authorization key (a 128-character string).

These keys can be generated in the EmailLabs panel under Account -> Settings -> API. For more details on how to generate the keys, see this guide.

API Documentation

EmailLabs for Developers! | EmailLabs API DOCSvercom.gitbook.io