Introduction

Welcome to the getting started for the Mailabl Dev Center!

Mailabl API​

The Mailabl API allows developers to programmatically access and update data inside their Mailabl account. Whether it's to integrate it with your website or some other application.

Mailabl API is fully built with GraphQL, which is a flexible query language that allows you to specify as much or as little data as you need. Learn more about the decision why we decided in favor of GraphQL over REST.

How does GraphQL work?​

GraphQL relies on a type system, where each object is a type and contains fields that define it. These fields can be scalars (such as integers) or can be objects themselves. Some fields also take arguments, which can be used to limit, filter, or sort the data that is returned.

Mutations are a special kind of field that update data.

When you make a query, you define what objects (and fields) you want to return. If you're returning a object that itself contains other fields, you need to define what data you want to return on that nested object.

Here's an example of a query for retrieving the currently authenticated user's data:

query {
  me {
    id
    firstName
    lastName
    email
  }
}

Learn more about GraphQL from the GraphQL Foundation introduction.

Start building​

To start building on Mailabl API:

1. You'll need a Mailabl account. If you already have one - great - one less step to complete.
2. An access token for authenticating your requests.
3. If you're not familiar with GraphQL we suggest you read through:
   1. How to read data from Mailabl API
   2. How to modify data in Mailabl API
4. Head over to the API Reference page for a more detailed overview of our schema.