Scan | Candid | API Reference

1 import requests 2 3 url = "https://api.joincandidhealth.com/api/events/v1/" 4 5 headers = {"Authorization": "<token>."} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "items": [ 3 { 4 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 5 "created_at": "2024-01-15T09:30:00Z", 6 "timestamp": "2024-01-15T09:30:00Z", 7 "event_type": "event_type", 8 "schema_version": "schema_version", 9 "payload": { 10 "key": "value" 11 } 12 }, 13 { 14 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 15 "created_at": "2024-01-15T09:30:00Z", 16 "timestamp": "2024-01-15T09:30:00Z", 17 "event_type": "event_type", 18 "schema_version": "schema_version", 19 "payload": { 20 "key": "value" 21 } 22 } 23 ], 24 "next_page_token": "next_page_token" 25 }

Scans the last 30 days of events. All results are sorted by created date, descending.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

page_tokenstringOptional

limitintegerOptional

Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10.

event_typesstringOptional

Event types to filter on. Defaults to showing all event types.

created_beforedatetimeOptional

Filters for only events created before this time (inclusive).

created_afterdatetimeOptional

Filters for only events created after this time (inclusive).

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstring or null

Authentication

Query parameters

Response

Errors