API Documentation

Learn about the overall functionality of the MailerCheck API.

Basic account API endpoints

Returns the account associated with the token being used.

GET /account

Response example

{
    "id": 1033,
    "name": "John Doe's Company",
    "created_at": "2020-02-10 15:34:54",
    "updated_at": "2020-02-28 13:21:23",
    "deleted_at": null,
    "credits": 430408,
    "first_name": null,
    "last_name": null,
    "company": null,
    "address": "123 nw",
    "city": "some city",
    "country": "somewhere",
    "postal_code": null,
    "region": null,
    "vat": null,
    "registration": null,
    "currency": null,
    "created_by": null
}

Returns the user associated with the token being used.

GET /user

Response example

{
    "id": 5,
    "name": "John Doe",
    "last_name": null,
    "email": "[email protected]",
    "email_verified_at": null,
    "subscribed_newsletter": 1,
    "avatar": null,
    "created_at": "2020-02-15 04:34:31",
    "updated_at": "2020-02-15 04:34:31",
    "terms_accepted_at": "2020-02-15 04:34:31"
}

Get the amount of credits the account associated with the token has.

GET /credits

Response example

{
    "total": 999949
}