API

Mail Reach features a full API (Application Programming Interface). In this tutorial we will show you how to use the API for accessing Mail Reach data.

Authentication

Contact us and we will provide you with an application password to use for making API calls. The application password allows API access to your Mail Reach site so make sure to store it securely.

Retrieving Prospect Data

In all requests, please replace www.domain.com with your own Mail Reach domain name.

Get a list of prospects

To get a list of prospects, we call the prospect endpoint:

curl --user "USERNAME:APPLICATION_PASSWORD" "https://www.domain.com/wp-json/wp/v2/prospect?status=publish,draft"

Return only specific fields

By default you will get all prospect fields. If you are interested in some fields only, you can use the _fields parameter to return only those specific fields (ID and First Name in this example):

curl --user "USERNAME:APPLICATION_PASSWORD" "https://www.domain.com/wp-json/wp/v2/prospect?status=publish,draft&_fields=id,first_name"

Review the prospect object when making a call without the _fields parameter to see all available prospect fields.

Pagination

By default, you will get 10 results per page. You can increase that to a maximum of 100 results with the per_page parameter:

curl --user "USERNAME:APPLICATION_PASSWORD" "https://www.domain.com/wp-json/wp/v2/prospect?status=publish,draft&per_page=100"

Then to get the results of page 2:

curl --user "USERNAME:APPLICATION_PASSWORD" "https://www.domain.com/wp-json/wp/v2/prospect?status=publish,draft&per_page=100&page=2"

With only these simple few types of calls we are able to get any prospect data we need.