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

Extract

List redemptionCodeRedeem

List redemptionCodeRedeem

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

Returns a paginated list of events emitted when a learner redeems a redemption code.

Example request

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

Parameters

NameTypeRequiredLocationDescription
kindstringYespathThe event kind to extract, supplied as the final path segment of the URL (redemptionCodeRedeem for this endpoint).
cursorstringNoqueryPagination cursor returned from a previous response; use to fetch the next page of results.
startDateintegerNoqueryReturns only events that occurred at or after this time, expressed as a Unix timestamp in milliseconds.
endDateintegerNoqueryReturns only events that occurred at or before this time, expressed as a Unix timestamp in milliseconds.

Example response

{
  "pageInfo": {
    "cursor": "string",
    "hasMore": true
  },
  "events": []
}

Response fields

FieldTypeDescription
pageInfoobjectCursor-based pagination metadata for the event stream.
pageInfo.cursorstringOpaque cursor to pass on the next request to retrieve the following page.
pageInfo.hasMorebooleanWhether additional pages of results are available.
eventsobject[]Array of event objects matching the query parameters.