List Events

import requests
url = "https://app.usebridge.com/api/events"
headers = {"X-API-Key": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "items": [
    {
      "apiVersion": "apiVersion",
      "eventId": "eventId",
      "createdAt": "2024-01-15T09:30:00Z",
      "eventType": "patient.created",
      "objectType": "objectType",
      "objectId": "objectId",
      "data": {
        "key": "value"
      },
      "previous": {
        "key": "value"
      }
    },
    {
      "apiVersion": "apiVersion",
      "eventId": "eventId",
      "createdAt": "2024-01-15T09:30:00Z",
      "eventType": "patient.created",
      "objectType": "objectType",
      "objectId": "objectId",
      "data": {
        "key": "value"
      },
      "previous": {
        "key": "value"
      }
    }
  ],
  "count": 1
}

Authentication

X-API-Keystring

API Key authentication via header

Query parameters

filter.eventTypestringOptional

Values should be JSON-encoded, for example filter.eventType=“patient.created”

filter.objectTypestringOptional

Values should be JSON-encoded, for example filter.objectType=“Patient”

filter.objectIdstringOptional

Values should be JSON-encoded, for example filter.objectId=“pol_xxx”

order.createdAtenumOptional

Allowed values:

pageintegerOptional

limitintegerOptional

Response

This endpoint returns an object.

itemslist of objects

List results

countinteger or null

Total count (if available)