List inferred interest topics

GET

/api/v3/contacts/custom-fields/interest-topics

const url = 'https://api.tryletterhead.com/api/v3/contacts/custom-fields/interest-topics?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/custom-fields/interest-topics?api=true' \
  --header 'Authorization: Bearer <token>'

Returns the interest topics Letterhead has inferred for your company’s contacts from their click activity, each with how many contacts carry it — the vocabulary the segment builder’s interest-topic criterion draws from. Commonest topic first, then alphabetically.

This capability is still rolling out; if it isn’t enabled for your account yet, this returns an empty list rather than an error.

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

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

200 OK

application/json

object

items

Array<object>

object

value

The interest topic.

string

contactCount

integer

message

string

total

integer

Example

{
  "items": [
    {
      "value": "outdoor recreation",
      "contactCount": 842
    },
    {
      "value": "personal finance",
      "contactCount": 611
    }
  ],
  "message": "Inferred interest values retrieved.",
  "total": 2
}

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