API Reference

Get contact details

This API endpoint fetches a contact's details.

This endpoint will provide details on a specific contact.

Endpoint

GET https://api.mailstand.com/contacts/{{contact_id}}

Parameters

FieldRequiredDescription
contact_idtrueUnique identifier for a contact.

API Call Example

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

200 Response

{
    id: "contact_m9kq9mLiHgwlGTJxrkh6z3nBL",
    workspace: "space_EVGG8f0vtZLHUI49bfGGTLBXk",
    status: "Reviewing",
    first_name: "John",
    middle_name: "Marshall",
    last_name: "Smith",
    full_name: "John Marshall Smith",
    nickname: "Johnny",
    email: "[email protected]",
    title: "CEO",
    mobile_phone: "1 (234) 456-7890",
    work_phone: "1 (234) 456-7890",
    home_phone: "1 (234) 456-7890",
    voip_phone: "1 (234) 456-7890",
    other_phone: "1 (234) 456-7890",
    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",
    source: "LinkedIn",
    custom_1: "First custom field",
    campaigns: [
        {
            campaign: "camp_Y3jjvpw7Po4sAA8NOhQQ7c8YT",
            stage: "stage_dB98HWTNiVKx3WQ4M6KI7z3Km",
            stage_name: "Reviewing",
            sending_mailbox: null,
            last_sent: null,
            last_open: null,
            last_click: null,
            last_reply: null,
            last_unsubscribe: null,
            last_bounce: null
        }
    ]
}

The status Field

The status field is a dynamic field. The API will look at the campaigns[stage] field and whatever the "most progressed" stage is present it will automatically be place that stage as the status on the contact. The stage order that we use as the "most progressed" logic is as follows:

  1. Reviewing
  2. Untouched
  3. Prospecting
  4. Unresponsive
  5. Replied
  6. Nurture
  7. Not Interested
  8. Interested
  9. Excluded
  10. Bad Contact Info
  11. Do Not Contact

So for example, if a contact is on two campaigns and in one campaign they are in the "Prospecting" stage and another one they are in "Replied" stage the status will be "Replied" because stage 5 is greater than stage 3. You can learn more about our stages here.