Skip to main content
GET
/
v1
/
contacts
/
lookup
cURL
curl --request GET \
  --url https://api.transmit.dev/v1/contacts/lookup \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "email_subscribed": true,
  "sms_subscribed": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}

Authorizations

ā€‹
Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Response

Contact found

ā€‹
id
string
required

Contact ID

ā€‹
email_subscribed
boolean
required

Email subscription status

ā€‹
sms_subscribed
boolean
required

SMS subscription status

ā€‹
created_at
string<date-time>
required

Creation timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
updated_at
string<date-time>
required

Last update timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
email
string<email>

Contact email address

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
ā€‹
phone_number
string

Contact phone number

ā€‹
first_name
string

First name

ā€‹
last_name
string

Last name