> ## Documentation Index > Fetch the complete documentation index at: https://docs.sphinxhq.com/llms.txt > Use this file to discover all available pages before exploring further. # List Events > List all events ## OpenAPI ````yaml /api_schema.yaml get /api/events/ openapi: 3.0.3 info: title: Sphinx API version: 1.0.0 description: > Automated compliance API for KYC/AML workflows. Sphinx handles PEP screening, sanctions checks, adverse media monitoring, and document verification with AI-powered decisions. **Quick Start:** 1. **Upload Documents** (Optional) - Required for KYB, KYC EDD, and transaction monitoring. Not required for AML checks (PEP, Sanctions, Adverse Media). 2. **Create a Case** - The case creation endpoint combines customer details and checks (typically a single alert) into one request. 3. **Receive Webhook** - Results are sent to your webhook URL when processing completes. **Authentication:** All API requests require a bearer token. Include it in the Authorization header: `Authorization: Token ` **Outcomes:** Each check returns an outcome (ACCEPTED, REJECTED, or PENDING) with detailed reasoning, risk scores (0.0-1.0), and audit-ready case notes in Markdown format. For detailed documentation, visit [docs.sphinxhq.com](https://docs.sphinxhq.com). servers: - url: https://app.sphinxhq.com description: Production server (US) - url: https://eu.sphinxhq.com description: Production server (EU) security: [] tags: - name: Cases description: >- Cases represent compliance reviews for a customer. Create a case, add checks, then start processing. - name: Checks description: >- Individual compliance checks within a case (e.g., PEP, Sanctions, Document Verification). - name: Customers description: >- Customer records linked to cases. Store customer details, type (individual/company), and external IDs. - name: Documents description: >- Upload and manage documents for cases and checks. Used for identity verification and document-based checks. **Allowed file types:** PDF, PNG, JPG, CSV, XLSX, DOCX, MD. - name: Events description: >- Timeline of activity on cases and checks: comments, outcome changes, assignments, status changes, reruns, and document activity. paths: /api/events/: get: tags: - Events summary: List Events description: List all events operationId: events_list parameters: - in: query name: case_id schema: type: integer description: >- Filter by case ID. Returns case-level events plus events on the case's checks. - in: query name: check_id schema: type: integer description: Filter by check ID - in: query name: event_type schema: type: string enum: - ASSIGNMENT_CHANGE - CASE_ESCALATION - CASE_OUTCOME_CHANGE - CASE_RERUN - CASE_STATUS_CHANGE - CHECK_OUTCOME_CHANGE - CHECK_RERUN - COMMENT - CUSTOMER_NAME_CHANGE - DOCUMENT_DELETE - DOCUMENT_UPLOAD - DOC_FRAUD_DISPUTE - NOTE_EDIT - REASONING_EDIT - RISK_LEVEL_CHANGE - SAR_APPROVED - SAR_ASSIGNMENT_CHG - SAR_GENERATED - SAR_REJECTED - SAR_REVOKE_APPROVAL - SAR_SUBMITTED description: Filter by event type - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: updated_after schema: type: string format: date-time description: >- Only events updated at or after this ISO 8601 timestamp. Comments are editable, so poll on updated_at. - in: query name: updated_before schema: type: string format: date-time description: Only events updated at or before this ISO 8601 timestamp responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEventReadList' description: '' security: - OAuthToken: [] - tokenAuth: [] - tokenAuth: [] components: schemas: PaginatedEventReadList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/EventRead' EventRead: type: object description: >- Read-only serializer for events (CheckEvent internally — never say "check event" externally). properties: id: type: integer readOnly: true case_id: type: integer readOnly: true nullable: true description: ID of the case. Null for check-level events. check_id: type: integer readOnly: true nullable: true description: ID of the check. Null for case-level events. event_type: enum: - COMMENT - CHECK_OUTCOME_CHANGE - CASE_OUTCOME_CHANGE - ASSIGNMENT_CHANGE - CASE_STATUS_CHANGE - RISK_LEVEL_CHANGE - CHECK_RERUN - CASE_RERUN - DOCUMENT_UPLOAD - DOCUMENT_DELETE - DOC_FRAUD_DISPUTE - CASE_ESCALATION - SAR_GENERATED - NOTE_EDIT - REASONING_EDIT - CUSTOMER_NAME_CHANGE - SAR_APPROVED - SAR_REJECTED - SAR_SUBMITTED - SAR_ASSIGNMENT_CHG - SAR_REVOKE_APPROVAL type: string x-spec-enum-id: dd8c52f8e6b463f0 description: |- Type of event * `COMMENT` - Comment * `CHECK_OUTCOME_CHANGE` - Check Outcome Change * `CASE_OUTCOME_CHANGE` - Case Outcome Change * `ASSIGNMENT_CHANGE` - Assignment Change * `CASE_STATUS_CHANGE` - Case Status Change * `RISK_LEVEL_CHANGE` - Risk Level Change * `CHECK_RERUN` - Check Rerun * `CASE_RERUN` - Case Rerun * `DOCUMENT_UPLOAD` - Document Upload * `DOCUMENT_DELETE` - Document Delete * `DOC_FRAUD_DISPUTE` - Doc Fraud Dispute * `CASE_ESCALATION` - Case Escalation * `SAR_GENERATED` - SAR Generated * `NOTE_EDIT` - Note Edit * `REASONING_EDIT` - Reasoning Edit * `CUSTOMER_NAME_CHANGE` - Customer Name Change * `SAR_APPROVED` - SAR Approved * `SAR_REJECTED` - SAR Rejected * `SAR_SUBMITTED` - SAR Submitted * `SAR_ASSIGNMENT_CHG` - SAR Assignment Change * `SAR_REVOKE_APPROVAL` - SAR Approval Revoked text: type: string previous_value: type: string nullable: true description: Previous value before change new_value: type: string nullable: true description: New value after change created_by: type: string format: email readOnly: true description: >- Email of the user who created the event. Null for system-generated events. created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true required: - case_id - check_id - created_at - created_by - id - text - updated_at securitySchemes: OAuthToken: type: http scheme: bearer description: >- OAuth2 access token obtained from POST /api/oauth/token/ using client credentials. tokenAuth: type: http scheme: bearer ````