Skip to main content
https://.thoughtindustries.com

Extract

List emailCapture

List emailCapture

GEThttps://example.thoughtindustries.com/incoming/v2/events/emailCapture

Returns a paginated list of email capture events, optionally filtered by date range, user, or notifiable resource.

Example request

curl "https://example.thoughtindustries.com/incoming/v2/events/emailCapture" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

NameTypeRequiredLocationDescription
kindstringNoqueryFilters results to a specific email capture event kind.
cursorstringNoqueryOpaque cursor string used to fetch the next page of results.
startDateISO 8601 timestampNoqueryReturns only events that occurred at or after this ISO 8601 timestamp.
endDateISO 8601 timestampNoqueryReturns only events that occurred at or before this ISO 8601 timestamp.
notifiableIduuidNoqueryFilters results to events associated with the specified notifiable resource.
userIduuidNoqueryFilters results to events associated with the specified user.

Example response

{
  "data": {
    "APIEvents": {
      "pageInfo": {
        "perPage": 0,
        "cursor": "string",
        "total": 0,
        "hasMore": true
      },
      "events": [
        {}
      ]
    }
  }
}

Response fields

FieldTypeDescription
pageInfoCursorPageInfoPagination metadata for the current result set.
pageInfo.perPageintegerNumber of events returned per page.
pageInfo.cursorstringOpaque cursor value used to retrieve the next page of results.
pageInfo.totalintegerTotal number of email capture events matching the request filters.
pageInfo.hasMorebooleanIndicates whether additional pages of results are available.
eventsobject[]Array of email capture event objects matching the request filters.