Get a contact's activity by contact key

GET

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

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

• Production

Same as Get a contact’s activity (GET /api/v3/contacts/{email}/activity), with the contact addressed by its contactKey instead of its email address.

Authorizations

• bearerAuth

Parameters

Path Parameters

contactKey

required

string

The contact’s opaque 64-character hex key.

Query Parameters

api

required

boolean

Set to true.

eventType[]

string

Repeatable. Return only these event types. One or more of delivery, open, click, bounce, purchase. Omit to return all five.

search

string

Free-text filter across the event’s newsletter title and link URL. Max 255 characters.

page

integer

1-based page number. Minimum 1. Defaults to 1.

limit

integer

Events per page. Minimum 1, maximum 100. Defaults to 50.

direction

string

Sort order on the event timestamp: desc (newest first, the default) or asc.

channel

string

Narrow the feed to a single newsletter by its channel slug. Omit for every newsletter in the company.

Responses

200

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

Media type application/json

object

items

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

object

message

string

total

integer

Example ^generated

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

400

400 Validation Error

Media type application/json

object

data

Array<string>

items

Array<object>

object

message

string

total

integer

Example ^generated

{
  "data": [
    "example"
  ],
  "items": [
    {}
  ],
  "message": "example",
  "total": 1
}