Get a contact by contact key

GET

/api/v3/contacts/keyed/{contactKey}

const url = 'https://api.tryletterhead.com/api/v3/contacts/keyed/example?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/contacts/keyed/example?api=true' \
  --header 'Authorization: Bearer <token>'

Same as Get a contact (GET /api/v3/contacts/{email}), with the contact addressed by its opaque contactKey instead of its email address. contactKey is the contact’s identifier on every v3 response (the contactKey field you get back from Browse contacts or Search contacts) — this is the only way to address a contact that has no email address, such as a phone-only contact.

This is a company-level (v3) read. Authenticate with a company API key as a Bearer token.

Authorizations

bearerAuth

Parameters

Path Parameters

contactKey

required

string

The contact’s opaque 64-character hex key (from a prior response’s contactKey field).

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

200 OK. Same shape as GET /api/v3/contacts/{email}.

application/json

object

items

The contact. Full field list under GET /api/v3/contacts/{email}.

object

message

string

total

integer

Example ^generated

{
  "items": {},
  "message": "example",
  "total": 1
}

Still can’t find what you need? Contact support.