Skip to main content

Get Customer

GET 
/account/customer/:email

Retrieves specific customer's details​

Retrieves the details of a specific customer associated with your account Use this endpoint to view comprehensive information about a customer, including their email address and any associated profile details, enabling full management of your account's customers.

Request​

Path Parameters

    email emailrequired

    Email of the customer

Responses​

successful operation

Schema
    email stringrequired
    firstName string
    lastName string
    source string
    status string

    Possible values: [Subscribed, Unsubscribed, Bounced, Inactive, Spam]

    birthday string
    tags string[]
    currency string
    country string
    province string
    city string
    address1 string
    address2 string
    phone string
    postalCode string
    company string
    lastPurchaseOrder string
    lastPurchasePrice string
    latestOrderId string
    lastPurchaseDate string
    unsubscribedAt string

    This field will be returned if the customer is Unsubscribed. It will be in the ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).

    customAttributes object

    Values for the custom attributes your account has defined, keyed by the attribute name exactly as you created it — spaces and capitalisation included (Interests, not Interest_list or interests).

    Send each value in the JSON type the attribute was defined with:

    Attribute typeSendExample
    STRINGa string"pro"
    INTEGERa whole number12
    DECIMALa number129.95
    DATEan ISO date or date-time"2026-09-01"
    BOOLEANtrue / falsetrue
    ARRAYa JSON array["cycling", "photography"]

    Prefer a real JSON array for an array attribute — that is the shape the segment builder matches against. A bracketed string such as "[cycling, photography]" is also accepted, for parity with CSV import, and is stored as a proper array.

    Dates must be ISO (2026-09-01, or a full ISO date-time). 09/01/2026 is rejected rather than guessed at, because it is a valid date under both MM/DD/YYYY and DD/MM/YYYY.

    Sending null for an attribute removes it from the contact.

    The request fails with 412 if it names an attribute your account has not defined, or if a value's type does not match the definition; the error message names every offending attribute. Nothing is stored in that case, so a 2xx means every attribute in the payload was saved.

    custom_attributes is accepted as an alias on the way in. Responses always use customAttributes.

    property name* any

    Values for the custom attributes your account has defined, keyed by the attribute name exactly as you created it — spaces and capitalisation included (Interests, not Interest_list or interests).

    Send each value in the JSON type the attribute was defined with:

    | Attribute type | Send | Example | | --- | --- | --- | | STRING | a string | "pro" | | INTEGER | a whole number | 12 | | DECIMAL | a number | 129.95 | | DATE | an ISO date or date-time | "2026-09-01" | | BOOLEAN | true / false | true | | ARRAY | a JSON array | ["cycling", "photography"] |

    Prefer a real JSON array for an array attribute — that is the shape the segment builder matches against. A bracketed string such as "[cycling, photography]" is also accepted, for parity with CSV import, and is stored as a proper array.

    Dates must be ISO (2026-09-01, or a full ISO date-time). 09/01/2026 is rejected rather than guessed at, because it is a valid date under both MM/DD/YYYY and DD/MM/YYYY.

    Sending null for an attribute removes it from the contact.

    The request fails with 412 if it names an attribute your account has not defined, or if a value's type does not match the definition; the error message names every offending attribute. Nothing is stored in that case, so a 2xx means every attribute in the payload was saved.

    custom_attributes is accepted as an alias on the way in. Responses always use customAttributes.

Loading...