This API endpoint fetches a list of contacts.
This endpoint will list all synced mailboxes on a workspace.
Endpoint
GET https://api.mailstand.com/mailboxes
Parameters
Field | Type | Required | Description |
---|---|---|---|
workspace | string | true | The workspace ID that you want to query. |
display | number | true | How many mailboxes to display/show per page. The max number that you can request is 2,000 at a time. |
page | number | true | The page you want to be on. |
API Call Example
This API call pulls all contacts on a specific campaign
.
GET https://api-dev.mailstand.com/mailboxes?display=50&page=1&workspace=space_EVGG8f0vtZLHUI49bfGGTLBXk
200 Response
{
"status": "ok",
"headers": [
"email",
"sender_name",
"campaigns",
"daily_limit",
"spf",
"dkim",
"dmarc",
"blacklists",
"age",
"sent_today",
"sent_30days",
"opened_14days",
"sent_90days",
"bounced_30days",
"avg_open_rate",
"avg_click_rate",
"last_activity",
"type",
"created"
],
"data": [
{
"id": "mailbox_QCsahthHNhDbfDBmq2irazcPK",
"status": "active",
"email": "[email protected]",
"sender_name": "Mike Jimmy",
"campaigns": 5,
"daily_limit": 50,
"spf": true,
"dkim": true,
"dmarc": true,
"blacklists": 3,
"age": "11 months",
"sent_today": 0,
"sent_30days": 37,
"opened_14days": 78.38,
"sent_90days": 37,
"bounced_30days": 0,
"avg_open_rate": 78.38,
"avg_click_rate": 10.81,
"last_activity": "1 day ago",
"type": "Google",
"created": "7 days ago",
"domain_ip": "185.230.63.171",
"server_ip": "209.85.220.41",
"created_at": 1657825703
},
{
"id": "mailbox_ABxEsbr3MIUrNE8yqn15eavND",
"status": "active",
"email": "[email protected]",
"sender_name": "Tyler Barnes",
"campaigns": 0,
"daily_limit": 50,
"spf": true,
"dkim": false,
"dmarc": false,
"blacklists": 1,
"age": "9 months",
"sent_today": 0,
"sent_30days": 1,
"opened_14days": 0,
"sent_90days": 1,
"bounced_30days": 0,
"avg_open_rate": 0,
"avg_click_rate": 0,
"last_activity": "7 days ago",
"type": "SMTP & IMAP",
"created": "14 days ago",
"domain_ip": null,
"server_ip": "40.107.94.43",
"created_at": 1657227708
}
],
"total_found": 2,
"current_page": 1,
"total_pages": 1
}