> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.useopenwrench.com/llms.txt > Use this file to discover all available pages before exploring further. # List WrenchMode events (work logs) > Read-only external flavour of the internal WrenchMode work-log feed, tenant-scoped to the API key's supplier. A present-but-memberless CSV filter (e.g. eventTypes=,) is rejected as malformed rather than ignored. ## OpenAPI ````yaml /openapi/supplier.json get /v1/supplier/wrench_mode/events openapi: 3.1.0 info: title: OpenWrench Supplier API version: 1.0.0 description: >- External REST API for OpenWrench suppliers (service providers). ## Authentication Every request must carry a supplier API key in the `X-API-KEY` header. The key resolves to a supplier contact; all reads and writes are tenant-scoped to that contact's supplier facility/company. Missing or invalid keys are answered with 401. ## Rate limiting 10 requests per 20-second window per API key. Requests beyond that are answered with 429 and the standard error envelope. (A few endpoints, noted in their descriptions, are not rate-limited.) ## Response envelope Single entity: `{"type": "", "data": {...}, "status": "ok"}`. Lists: `{"type": "", "data": [...], "count": , "status": "ok"}`. count_by endpoints return the integer count in `data`. The `type` label is hard-coded on some endpoints (e.g. "WorkOrderNotes", "pingpong") and derived via Scala reflection on generic CRUD endpoints, where it may appear as the fully qualified server class name - treat it as informational. Errors: `{"message": "...", "type": "", "status": "error", "traceId": "..."}` with HTTP 400 (bad input, and also permission-denied reads/writes), 401 (missing/invalid key), 404 (not found), 429 (rate limit). ## Pagination List endpoints accept `offset`, `limit` (default 10, max 25 - the supplier locations list caps at 10), `sort_by` and `order` (`asc`|`desc`), plus entity-specific query-string filters on indexed columns. ## Data masking For third-party suppliers (keys whose supplier company is not a buyer's internal service team), work order, location and invoice responses are masked: buyer-private fields are blanked before the response is returned. ## Date formats Date-time fields serialize as strings in one of two shapes depending on the underlying type: ISO 8601 with offset (e.g. `2026-08-14T13:05:22.000-07:00`) for most timestamps, or `yyyy-MM-dd HH:mm:ss.S` (space-separated, no offset) for database timestamp fields. Plain dates are `yyyy-MM-dd`. When sending date-times, ISO 8601 is accepted. ## Required headers Every request must carry BOTH `X-API-KEY` (your API key) and `OW-KEY` (the OpenWrench shared secret issued with it). Requests missing either return 401. servers: - url: https://api.useopenwrench.com/api/external security: - ApiKeyAuth: [] OwKeyAuth: [] tags: - name: Ping - name: Buyer Companies - name: Locations - name: Regions - name: Asset Types - name: Assets - name: Asset Labels description: Read the asset label catalog and replace the labels applied to an asset. - name: Work Orders - name: Work Order Labels description: >- Read the work order label catalog visible to your key and replace the labels applied to a work order. - name: Service Calls - name: WrenchMode description: Read-only WrenchMode work logs and technician time analytics - name: Proposals - name: Invoices - name: Files - name: Purchase Requests - name: Purchase Orders - name: Purchase Order Receipts - name: Parts - name: Equipment Types - name: Stock Location Inventory - name: Vendors - name: Users paths: /v1/supplier/wrench_mode/events: get: tags: - WrenchMode summary: List WrenchMode events (work logs) description: >- Read-only external flavour of the internal WrenchMode work-log feed, tenant-scoped to the API key's supplier. A present-but-memberless CSV filter (e.g. eventTypes=,) is rejected as malformed rather than ignored. operationId: listWrenchModeEvents parameters: - name: scheduleId in: query required: false schema: type: integer format: int64 description: >- Filter to one WrenchMode schedule. When present, pagination is DISABLED and the schedule's full event timeline is returned. - name: workOrderId in: query required: false schema: type: integer format: int64 description: Filter by work order id. - name: serviceCallId in: query required: false schema: type: integer format: int64 description: Filter by service call id. - name: locationId in: query required: false schema: type: integer format: int64 description: Filter by location id. - name: eventTypes in: query required: false schema: type: string description: >- Comma-separated list of event types. Valid values: began_trip, trip_paused, trip_resumed, arrived, trip_cancelled, drive_note, started_work, ended_work, location_started, location_paused, location_resumed, location_ended. Unknown values are rejected with 400. - name: supplierEmails in: query required: false schema: type: string description: >- Comma-separated list of technician emails, matched case-insensitively. (Only the plural key is exposed.) - name: fromDate in: query required: false schema: type: string description: Window start, yyyy-MM-dd. Malformed dates are rejected with 400. - name: toDate in: query required: false schema: type: string description: Window end, yyyy-MM-dd. Malformed dates are rejected with 400. - name: offset in: query required: false schema: type: integer minimum: 0 description: Number of records to skip. - name: limit in: query required: false schema: type: integer description: Page size. Default 10, maximum 25. - name: sort_by in: query required: false schema: type: string description: Column name to sort by. - name: order in: query required: false schema: type: string enum: - asc - desc description: Sort direction. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/WrenchModeEventListResponse' '400': description: >- Bad input, validation failure, or the API key's contact could not be resolved content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid X-API-KEY content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded (10 requests per 20-second window) content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: WrenchModeEventListResponse: type: object properties: type: type: string description: >- Entity type label, e.g. "WrenchModeEvent". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational. data: type: array items: $ref: '#/components/schemas/WrenchModeEvent' count: type: integer format: int64 description: Total number of matching records (across all pages) status: type: string description: '"ok" on success' enum: - ok required: - type - data - count - status Error: type: object properties: message: type: string description: Human-readable error message type: type: string description: >- Exception type identifier. Known values (exact casing): "unauthorizedException", "authorizationException", "ParseException", "UnexpectedException", "NotFoundException", "BadRequestException", "PaymentRequiredException", "InvalidInputDataException", "ConflictException", "ForbiddenException", "InvalidInputException" status: type: string enum: - error traceId: type: string description: >- Server-generated trace identifier for support (11 alphanumeric characters) required: - message - type - status - traceId description: Standard error envelope returned for 4xx/5xx responses. WrenchModeEvent: type: object properties: id: anyOf: - type: integer format: int64 - type: 'null' scheduleId: type: integer format: int64 supplierEmail: type: string locationId: anyOf: - type: integer format: int64 - type: 'null' workOrderId: anyOf: - type: integer format: int64 - type: 'null' note: anyOf: - type: string - type: 'null' serviceCallId: anyOf: - type: integer format: int64 - type: 'null' eventType: type: string enum: - began_trip - trip_paused - trip_resumed - arrived - trip_cancelled - drive_note - started_work - ended_work - location_started - location_paused - location_resumed - location_ended supplierFacilityId: type: integer isDeleted: type: boolean deletedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - scheduleId - supplierEmail - eventType - supplierFacilityId - isDeleted securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY OwKeyAuth: type: apiKey in: header name: OW-KEY description: >- OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key. ````