Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Retrieve a contact

GET/contacts/{id}
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstringrequis
longueur min 1
Réponses
200

Contact

idstring<uuid>requis
emailstringrequis
first_namestring | nullrequis
last_namestring | nullrequis
created_atstringrequis
unsubscribedbooleanrequis

Opt-out from every marketing send of the team, whichever domain sends. A recipient's own unsubscribe never sets it: that is recorded for the domain whose email carried the link (see unsubscribed_domains).

unsubscribed_domainsobject[]requis

BillionSend extension: the domains this contact unsubscribed from through a link in their email. Marketing sends from those domains skip the contact; other domains still reach them. The team-wide opt-out is unsubscribed, not an entry here. Remove an entry with DELETE /unsubscribes/{id}.

Afficher les propriétés
Tableau de object
domain_idstring<uuid> | nullrequis

Null when the domain has since been deleted from the team

namestringrequis

The domain's name

unsubscribed_atstringrequis
verification_statusstring | nullrequis

BillionSend extension: the verdict of the contact's last deep verification (POST /verifications); null while it was never verified

Valeurs autorisées :validinvalidriskycatchallroledisposableunknownnull
verified_atstring | nullrequis

When the last deep verification finished; null while never verified

objectstringrequis
Valeurs autorisées :contact
propertiesobjectrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/contacts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "created_at": "string",
  "unsubscribed": true,
  "unsubscribed_domains": [
    {
      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
      "name": "string",
      "unsubscribed_at": "string"
    }
  ],
  "verification_status": "valid",
  "verified_at": "string",
  "object": "contact",
  "properties": {
    "property1": {
      "type": "string",
      "value": "string"
    },
    "property2": {
      "type": "string",
      "value": "string"
    }
  }
}

Cette page vous a-t-elle été utile ?