getContact method

Getting information about a single contact.

Principle of use

URL to call the method
https://api.selzy.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL
Arguments
api_key* API access key.
email * Email address. Returns contact data by the given value of this parameter.
include_lists Displays information about the lists to which the contact has been added. The parameter takes the value 1 or 0.
include_fields Display information about custom contact fields. The parameter takes the value 1 or 0.
include_details Displays additional information about the contact. The parameter takes the value 1 or 0.

 

Return value
JSON object with the following fields:
email Contact information list:

Email parameter fields
email Email address of contact.
added_at The time the contact was created in the format “YYYY-MM-DD hh:mm:ss” in UTC.
status Email address status. The valid values are listed in the list of system fields below:

  • new — new.
  • invited – invitation sent with a subscription confirmation link, waiting for an answer, mailing to this address impossible.
  • active – active address, mailing is possible.
  • inactive – address disabled via web interface, all mailings are impossible, can be again enabled via the web interface.
  • unsubscribedrecipient unsubscribed from all mailings.
  • blocked – address blocked by the administration of our service (for example, on the recipient’s complaint), mailing impossible. Unlocking is possible only at the request of the recipient.
  • activation_requested – requested activation of the address from the administration Selzy, mailing is not yet possible.
availability Availability of email address. Possible values:

  • available — the address is available.
  • unreachable — address unavailable.
  • temp_unreachable — address temporarily unavailable.
  • mailbox_full — mailbox is full.
  • spam_rejected — The email is considered spam by the recipient’s server. In a few days this status will be removed.
  • spam_folder — the email is placed in spam by the recipient.
last_send_datetime The time of the last email sent to this email address in the format “YYYY-MM-DD hh:mm:ss” in UTC. If this event has not occurred yet, the value will be - null.
The value is returned when using the inlcude_details parameter.
last_delivery_datetime The time of the last email delivery to this email address in the format “YYYY-MM-DD hh:mm:ss” in UTC.
If this event has not occurred yet, the value will be - null.
The value is returned when using the inlcude_details parameter.
last_read_datetime The last time an email was read by this email address in the format “YYYY-MM-DD hh:mm:ss” in UTC.
If this event has not occurred yet, the value will be - null.
The value is returned when using the inlcude_details parameter.
last_click_datetime The last time the email address clicked on links in email, in the format “YYYY-MM-DD hh:mm:ss” in UTC.
If this event has not occurred yet, the value will be - null.
The value is returned when using the inlcude_details parameter.
rating Email address rating shows the activity of the contact. The value takes the form from “0.0” to “5.0”
If there was no sending, the value will be - null.
The value is returned when using the inlcude_details parameter.
phone The parameter is included in the response only if a phone number is specified in the contact card.

Phone parameter fields
phone The contact’s phone number.
added_at The time the contact was created in the format “YYYY-MM-DD hh:mm:ss” in UTC.
status The phone number’s status. Valid values are listed in the list of system fields below:

  • new - new.
  • active - active address, mailing is possible. The phone number gets default status.
  • inactive - address disabled via web interface, all mailings are impossible, can be again enabled via the web interface.
  • unsubscribed - recipient unsubscribed from all mailings.
  • blocked - address blocked by the administration of our service (for example, on the recipient's complaint), mailing impossible. Unlocking is possible only at the recipient’s request.
availability The phone number’s availability. Possible values:

  • available — the phone number is available.
  • not_allowed — the phone number unavailable.
  • temp_unreachable — the phone number is temporarily unavailable.
  • not_exist — the phone number does not exist.
lists List Data caused by the include_lists parameter

Lists parameter fields
id List id.
status The status of the email address in the list. List of statuses
added_at The time the contact was added to the list in the format “YYYY-MM-DD hh:mm:ss” in UTC.
fields List of custom fields and their values, caused by the include_fields parameter.
{
  "result":{
   "email":{
    "email":"[email protected]",
    "added_at": "2025-01-21 14:02:31",
    "status": "active",
    "availability": "available",
    "last_send_datetime": "2025-03-11 10:42:29",
    "last_delivery_datetime": "2025-03-11 10:42:33",
    "last_read_datetime": "2025-03-11 10:45:10",
    "last_click_datetime": "2025-03-11 10:45:10",
    "rating": 4.1
   },
   "phone": {
   "phone": "380123456789",
   "added_at": "2025-01-21 14:02:31",
   "status": "active",
   "availability": "available"
   },
   "fields": {
    "Name": "local part",
    "field2": "some value"
   },
   "lists":[
      {
       "id": "11235892",
       "status": "active",
       "added_at": "2025-01-21 14:02:31"
   },
   {  
       "id": "33567123",
       "status": "unsubscribed",
       "added_at": "2025-01-21 14:02:31"
   }
  ]
 }
}

Examples of forming the URL request

https://api.selzy.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL;
https://api.selzy.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL&include_lists=1&include_fields=1&include_details=1
Did we answer your question?
2
1

To get more help, contact our Support Team. They are available for all Selzy users 24/7.