Extract

List award

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

Returns a paginated list of award events, optionally filtered by user, notifiable object, award kind, or date range.

Example request

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

Parameters

Name	Type	Required	Location	Description
`kind`	`string`	No	query	Filters results to a specific award type.
`cursor`	`string`	No	query	Opaque cursor string used to fetch the next page of results.
`startDate`	`ISO 8601 timestamp`	No	query	Returns only events on or after this ISO 8601 timestamp.
`endDate`	`ISO 8601 timestamp`	No	query	Returns only events on or before this ISO 8601 timestamp.
`notifiableId`	`uuid`	No	query	Filters results to events associated with the specified notifiable object.
`userId`	`uuid`	No	query	Filters results to events belonging to the specified user.

Example response

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

Response fields

Field	Type	Description
`pageInfo`	`CursorPageInfo`	Pagination metadata for the current result set.
`pageInfo.perPage`	`integer`	Number of events returned per page.
`pageInfo.cursor`	`string`	Cursor value to pass in the next request to retrieve the following page.
`pageInfo.total`	`integer`	Total number of award events matching the query.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`events`	`object[]`	Array of award event objects matching the query.