Get Contact
You can retrieve the details of an existing contact in your account by sending a GET request to the API endpoint. Your request must include the contact's email address.
Endpoint Information
Endpoint: https://manage.maileroo.app/v1/contact/[:list_id]/[:email_address]
Method: GET
Content Type: application/json
Where To Find Your List ID
You can find your list ID in your when you to go to your 'Contacts' section within your organization. There it will display the list-id that you can use in this endpoint.
Request
The GET request does not require a request body. All necessary information is provided in the URL parameters.
Request Headers
Content-Type: application/json
X-API-Key: YOUR_API_KEY_HERE
URL Parameters
Parameter | Type | Description |
---|---|---|
list_id | string | The ID of the list containing the contact |
email_address | string | The email address of the contact to retrieve |
Response
The response will be a JSON object representing the contact you requested. The contact object will include the contact's email address and any additional fields you have included.
Field | Type | Description |
---|---|---|
success | boolean | Boolean indicating whether the request was successful |
message | string | Message describing the result of the request |
contact | object | Object representing the contact |
Success Response
{
"success": true,
"message": "Contact retrieved successfully",
"contact": {
"subscriber_name": "John Doe",
"subscriber_email": "[email protected]",
"subscriber_timezone": "America/New_York",
"subscriber_tags": "tag1,tag2",
"subscriber_status": "UNCONFIRMED",
"custom_field1": "value1",
"custom_field2": "value2"
}
}
Error Response
{
"success": false,
"message": "Contact not found"
}