Skip to main content
GET
/
api
/
v3
/
tap
/
events
Get Tap Events
curl --request GET \
  --url https://server.stage.overflow.co/api/v3/tap/events \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'
{
  "data": [
    {
      "id": "6816f8dc7d2a1b4c12ab3522",
      "createdAt": "2026-05-04T14:12:44.002Z",
      "deviceId": "<string>",
      "groupId": "<string>",
      "destinationId": "<string>",
      "device": {
        "id": "<string>",
        "serialNumber": 123
      },
      "group": {
        "id": "<string>",
        "name": "<string>"
      },
      "destination": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "totalCount": 100
}

Documentation Index

Fetch the complete documentation index at: https://docs.overflow.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-client-id
string
header
required

Client ID for API authentication

​
x-api-key
string
header
required

API Key for API authentication

Query Parameters

​
limit
number
default:25

The number of tap events to return.

Required range: 1 <= x <= 100
​
page
number
default:1

The page number of the tap events to return.

Required range: x >= 1
​
groupIds
string[]

Filter tap events by group IDs.

Minimum array length: 1
Example:
["6710f34fd5061afeec3eab58"]
​
destinationIds
string[]

Filter tap events by destination IDs.

Minimum array length: 1
Example:
["6710f34fd5061afeec3eab57"]
​
deviceIds
string[]

Filter tap events by device IDs.

Minimum array length: 1
Example:
["6710f34fd5061afeec3eab59"]
​
startDate
string<date-time>

Filter tap events on or after this date (ISO 8601).

Example:

"2026-05-01T00:00:00.000Z"

​
endDate
string<date-time>

Filter tap events on or before this date (ISO 8601).

Example:

"2026-05-08T23:59:59.999Z"

​
sortDirection
enum<string>
default:DESC

The direction to sort the tap events by. Events are always sorted by time of occurrence.

Available options:
ASC,
DESC
Example:

"DESC"

Response

200 - application/json
​
data
object[]
required

List of tap events.

​
totalCount
number
required

Total number of tap events matching the filters.

Example:

100