Skip to content
/
Get Contact

Get Contact

Request

Returns the complete data of a contact.

Path
subscriberidstringrequired

The identifier of the contact. This can be either:

  • Internal Subscriber ID (Contact ID)
    Recommended for internal, server-side integrations.
    Numeric string, for example 987654321.

  • External Subscriber Key (Contact Key)
    Recommended for external communication such as email links, redirect URLs and form integrations.
    Alphanumeric string, for example 01234abcdefghij56789.

Both identifiers can be used interchangeably in this endpoint.

Example:987654321
GET
/subscriber/{subscriberid}
curl -i -X GET \
  https://api.klicktipp.com/subscriber/987654321

Responses

Success Response.

Bodyapplication/json
idstringrequired

Unique internal identifier of the contact

Example:"987654321"
emailstringrequired

Primary email address of the contact

Example:"alex.example@klicktipp.example"
statusstringrequired

Current email subscription status of the contact (state, legacy string value)

Example:"Subscribed"
bouncestringrequired

Bounce status of the contact email address (state, legacy string value)

Example:"Not Bounced"
listidstringrequired

ID of the opt-in process (list) the contact belongs to at the time of subscription

Example:"12345"
optinstringrequired

Time when the opt-in process for email communication was initiated (legacy formatted datetime string)

Example:"01.01.2025 12:00:00"
optin_ipstringrequired

IP address associated with initiating the opt-in process for email communication. Legacy behavior: For API-based subscriptions, this field may contain additional descriptive text and does not represent a pure IP address.

Example:"0.0.0.0"
datestringrequired

Time when the opt-in process for email communication was successfully confirmed (legacy formatted datetime string)

Example:"01.01.2025 13:00:00"
ipstringrequired

IP address associated with confirming the opt-in process for email communication. Legacy behavior: For API-based subscriptions, this field may contain additional descriptive text and does not represent a pure IP address.

Example:"0.0.0.0"
unsubscriptionstringrequired

Time when the contact unsubscribed from email communication (legacy formatted datetime string). Empty if the contact is subscribed.

Example:""
unsubscription_ipstringrequired

IP address associated with the unsubscription from email communication. Legacy behavior: For API-based unsubscriptions, this field may contain additional descriptive text. Empty if the contact is subscribed.

Example:""
referrerstringrequired

Optional referrer indicating the website where the email subscription form was embedded at the time of opt-in initiation. Legacy best-effort field and often empty.

Example:"https://integration.example.com/webhooks/payment/ipn"
sms_phonestringrequired

Phone number used for SMS communication

Example:"00491701234567"
sms_statusstringrequired

Current SMS subscription status of the phone number (state, legacy string value)

Example:"Subscribed"
sms_bouncestringrequired

SMS bounce status of the phone number (state, legacy string value)

Example:"Not Bounced"
sms_datestringrequired

Time when the SMS subscription became active (legacy formatted datetime string)

Example:"01.02.2025 12:00:00"
sms_unsubscriptionstringrequired

Time when the contact unsubscribed from SMS communication (legacy formatted datetime string). Empty if subscribed.

Example:""
sms_referrerstringrequired

Optional referrer indicating the website where the SMS subscription form was embedded at the time of opt-in initiation. Legacy best-effort field and often empty.

Example:"https://signup.example.com/sms-form"
fieldFirstNamestringrequired

Global data field: first name of the contact

Example:"Alex"
fieldLastNamestringrequired

Global data field: last name of the contact

Example:"Example"
fieldCompanyNamestringrequired

Global data field: company name of the contact

Example:"Example Corp"
fieldStreet1stringrequired

Global data field: primary street address

Example:"Example Street 1"
fieldStreet2stringrequired

Global data field: additional address information

Example:""
fieldCitystringrequired

Global data field: city

Example:"Berlin"
fieldStatestringrequired

Global data field: state or region

Example:"Berlin"
fieldZipstringrequired

Global data field: postal or ZIP code

Example:"10115"
fieldCountrystringrequired

Global data field: country code

Example:"DE"
fieldPrivatePhonestringrequired

Global data field: private phone number

Example:"00491701234567"
fieldMobilePhonestringrequired

Global data field: mobile phone number

Example:"00491707654321"
fieldPhonestringrequired

Global data field: business phone number

Example:"00492207654321"
fieldFaxstringrequired

Global data field: fax number

Example:"00492201234567"
fieldWebsitestringrequired

Global data field: website URL

Example:"https://www.klicktipp.example"
fieldBirthdaystringrequired

Global data field: birthday stored as Unix timestamp (seconds)

Example:"755222400"
fieldLeadValuestringrequired

Global data field: lead score or lead value

Example:"100"
tagsArray of stringsrequired

List of all tag IDs currently assigned to the contact, including manual and smart tags

Example:
[
  "17",
  "18",
  "19",
  "20"
]
smart_tagsobjectrequired

Smart tag IDs mapped to the Unix timestamp when they were applied (subset of assigned tags)

Example:
{
  "17": "1758821945",
  "18": "1758822131"
}
manual_tagsobjectrequired

Manually assigned tag IDs mapped to the Unix timestamp when they were applied (subset of assigned tags)

Example:
{
  "19": "1759753677",
  "20": "1758822131"
}
notification_emails_sentobjectrequired

Notification email IDs mapped to the Unix timestamp when they were sent

Example:
{
  "45": "1758821945"
}
notification_emails_openedobjectrequired

Notification email IDs mapped to the Unix timestamp when they were opened

Example:
{
  "45": "1758822131"
}
notification_emails_clickedobjectrequired

Notification email IDs mapped to the Unix timestamp when they were clicked

Example:
{
  "45": "1758822131"
}
emails_sentobjectrequired

Email IDs mapped to the Unix timestamp when they were sent

Example:
{
  "1": "1758822606",
  "2": "1758822769"
}
emails_openedobjectrequired

Email IDs mapped to the Unix timestamp when they were opened

Example:
{
  "1": "1758822610",
  "2": "1758884682"
}
emails_clickedobjectrequired

Email IDs mapped to the Unix timestamp when they were clicked

Example:
{
  "1": "1758822733"
}
campaigns_startedobjectrequired

Campaign IDs mapped to the Unix timestamp when they were started

Example:
{
  "6": "1759753673"
}
campaigns_finishedobjectrequired

Campaign IDs mapped to the Unix timestamp when they were finished

Example:
{
  "6": "1759753677"
}
Response
{
  "id": "987654321",
  "email": "alex.example@klicktipp.example",
  "status": "Subscribed",
  "bounce": "Not Bounced",
  "listid": "12345",
  "optin": "01.01.2025 12:00:00",
  "optin_ip": "0.0.0.0",
  "date": "01.01.2025 13:00:00",
  "ip": "0.0.0.0",
  "unsubscription": "",
  "unsubscription_ip": "",
  "referrer": "https://integration.example.com/webhooks/payment/ipn",
  "sms_phone": "00491701234567",
  "sms_status": "Subscribed",
  "sms_bounce": "Not Bounced",
  "sms_date": "01.02.2025 12:00:00",
  "sms_unsubscription": "",
  "sms_referrer": "https://signup.example.com/sms-form",
  "fieldFirstName": "Alex",
  "fieldLastName": "Example",
  "fieldCompanyName": "Example Corp",
  "fieldStreet1": "Example Street 1",
  "fieldStreet2": "",
  "fieldCity": "Berlin",
  "fieldState": "Berlin",
  "fieldZip": "10115",
  "fieldCountry": "DE",
  "fieldPrivatePhone": "00491701234567",
  "fieldMobilePhone": "00491707654321",
  "fieldPhone": "00492207654321",
  "fieldFax": "00492201234567",
  "fieldWebsite": "https://www.klicktipp.example",
  "fieldBirthday": "755222400",
  "fieldLeadValue": "100",
  "tags": [
    "17",
    "18",
    "19",
    "20"
  ],
  "smart_tags": {
    "17": "1758821945",
    "18": "1758822131"
  },
  "manual_tags": {
    "19": "1759753677",
    "20": "1758822131"
  },
  "notification_emails_sent": {
    "45": "1758821945"
  },
  "notification_emails_opened": {
    "45": "1758822131"
  },
  "notification_emails_clicked": {
    "45": "1758822131"
  },
  "emails_sent": {
    "1": "1758822606",
    "2": "1758822769"
  },
  "emails_opened": {
    "1": "1758822610",
    "2": "1758884682"
  },
  "emails_clicked": {
    "1": "1758822733"
  },
  "campaigns_started": {
    "6": "1759753673"
  },
  "campaigns_finished": {
    "6": "1759753677"
  }
}