List all contacts

This API endpoint fetches a list of contacts.

This endpoint will list all contacts on a workspace. You can also use further filtering to list contacts on a campaign and search for contacts across your workspace.

Endpoint

cURL

GET https://api.mailstand.com/contacts

Parameters

Field	Type	Required	Description
workspace	string	true	The workspace ID that you want to query
display	number	true	How many contacts to display/show per page. The max number that you can request is 2000 at a time.
page	number	true	The page you want to be on
campaign	string		Filter search by campaign_id.
search	string		Filter search by keyword. This keyword searches across the email field on the contact record.
stage	string		The possible searches are Reviewing, Untouched, Prospecting, Replied, Unresponsive, Do Not Contact, Bad Contact Info, Interested, Not Interested, Nurture, Excluded. You can learn more about these stages here.
has_opened	boolean		Filters for contacts that have opened an email.
has_clicked	boolean		Filters for contacts that have clicked an email.
has_replied	boolean		Filters for contacts that have replied to an email.
has_bounced	boolean		Filters for contacts that have bounced.

API Call Example

This API call pulls all contacts on a specific campaign.

cURL

GET https://api.mailstand.com/contacts?campaign=camp_Y3jjvpw7Po4sAA8NOhQQ7c8YT&display=50&page=1&workspace=space_EVGG8f0vtZLHUI49bfGGTLBXk

200 Response

JSON

{
    status: "ok",
   	headers: [
        "active",
        "email",
        "stage",
        "full_name",
        "first_name",
        "middle_name",
        "last_name",
        "nickname",
        "title",
        "mobile_phone",
        "work_phone",
        "home_phone",
        "voip_phone",
        "other_phone",
        "lead_score",
        "company_name",
        "company_formal_name",
        "company_industry",
        "address_1",
        "address_2",
        "city",
        "state",
        "zip",
        "country",
        "region",
        "timezone",
        "gender",
        "occupation",
        "linkedin",
        "twitter",
        "stack_overflow",
        "website_1",
        "website_2",
        "website_3",
        "personal_note_1",
        "personal_note_2",
        "personal_note_3",
        "job_start_date",
        "school",
        "graduation_date",
        "degree",
        "locked_mailbox",
        "created_at",
        "last_updated",
        "last_activity",
        "custom_1-space_EVGG8f0vtZLHUI49bfGGTLBXk-crm_id"
    ],
    data: [
        {
            id: "contact_m9kq9mLiHgwlGTJxrkh6z3nBL",
            active: "locked",
            email: "[email protected]",
            stage: "Reviewing",
            full_name: "John Marshall Smith",
            first_name: "John",
            middle_name: "Marshall",
            last_name: "Smith",
            nickname: "Johnny",
            title: "CEO",
            mobile_phone: "1 [phone]",
            work_phone: "1 [phone]",
            home_phone: "1 [phone]",
            voip_phone: "1 [phone]",
            other_phone: "1 [phone]",
            lead_score: "75",
            company_name: "Acme",
            company_formal_name: "Acme, Inc.",
            company_industry: "Manufacturing",
            address_1: "5 Apple Road",
            address_2: "Suite 555",
            city: "Philadelphia",
            state: "PA",
            zip: "19019",
            country: "USA",
            region: "Philadelphia",
            timezone: "America/New_York",
            gender: "Male",
            occupation: "CEO",
            linkedin: "https://www.linkedin.com/",
            twitter: "https://twitter.com/",
            stack_overflow: "https://stackoverflow.com/",
            website_1: "https://acme.com/",
            website_2: "https://acme.com/about-us",
            website_3: null,
            personal_note_1: "Note 1",
            personal_note_2: "Note 2",
            personal_note_3: "Note 3",
            job_start_date: "01/01/2022",
            school: "Yale",
            graduation_date: "06/01/2023",
            degree: "Masters",
            locked_mailbox: null,
            locked_mailbox_id: null,
            locked_mailbox_color: null,
            created_at: "47 minutes ago",
            last_updated: "47 minutes ago",
            last_activity: "47 minutes ago",
            custom_1: null,
            created: 1654714807,
            last_sent: null,
            last_open: null,
            last_click: null,
            last_reply: null,
            last_unsubscribe: null,
            last_bounce: null
        },
        //... 13 More Contacts
    ],
    total_found: 14,
    current_page: 1,
    total_pages: 1
}

Filtering By Campaign

When filtering by campaign we will also provide these additional fields.

1. last_sent
2. last_open
3. last_reply
4. last_unsubscribe
5. last_bounce

If a contact has not done one of these actions yet the field will be null otherwise we will provide a unix timestamp.