Retrieve a contact

Parameters

Request

curl -X GET 'https://app.mailyte.com/api/v1/contacts/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/contacts/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/contacts/01JBT8XQ2M9WYC3K4F6R7S8T9V",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/contacts/01JBT8XQ2M9WYC3K4F6R7S8T9V');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/contacts/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringcontact
  • idstring

    Unique identifier for the contact.

  • emailstring

    Lower-cased and trimmed on write, so the address you read back may not be byte-identical to the one you sent.

  • namestring

    The contact's name. Null when none was given; {{ name }} is then empty unless your template gives a fallback.

  • statestringsubscribed | unsubscribed | bounced | complained | suppressed

    Whether this contact will be emailed. subscribed means yes; any other value is the reason not. It combines the contact's status with your suppression list, so a subscribed contact whose address is suppressed reads suppressed. Read-only: you set status (subscribed, unsubscribed, bounced or complained) instead. Note that ?status= filters on status, not on this.

  • email_statusstringpending | valid | risky | invalid | unknown | not_checked

    The result of checking whether the mailbox exists. valid: it exists. invalid: it does not. risky: it may not take mail (a catch-all domain, a role address such as info@, a throwaway address or a full inbox). unknown: the check could not tell. pending: being checked. not_checked: added after Bounce protection launched and not checked. Null: never checked, from before Bounce protection launched. Read-only; filter with ?email_status=.

  • email_full_untilstring

    Until when marketing to this contact is held because their inbox is full. When a check finds the inbox full, marketing waits 7 days; near the end it is checked again for free and the hold either ends or runs another 7 days. App email is never held. Null means no hold. Read-only.

  • fieldsobject

    Custom field values, keyed by the field's key (the name {{ signup_date }} uses). Always an object, {} when empty. Values are strings as stored; field defaults are not filled in here. When writing, send these as attributes.

  • listsarray<object>

    The lists this contact is on, with their names. When writing, send list IDs as list_ids.

    • idstring
    • namestring
  • tagsarray<object>

    Your labels on this contact, with their names.

    • idstring
    • namestring
  • interestsarray<object>

    What this contact chose on a form, each with the question it answers. [] means they chose nothing.

    • idstring

      Match on this in a segment rule, never on the name.

    • namestring

      The answer, as the contact read it.

    • category_idstring

      The question this answers.

    • category_titlestring

      The question in words. null MEANS NOT INCLUDED — the category was not loaded, never that the question has no title.

  • consentobject

    How this contact agreed to be emailed. Each field is null when we have no record. Set it when you import from another service, so your proof of consent comes with your contacts.

    • atstring

      When they agreed. Null when unknown.

    • ipstring

      The IP address they agreed from. Null when unknown.

    • sourcestring

      Where they agreed, such as a form name, a URL or "imported from Mailchimp". Null when unknown.

  • sourcestring

    How this contact was added: manual, import_api, import_csv or your own text (up to 50 characters). Null when nothing was recorded.

  • created_atstring
  • updated_atstring

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.