> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Search driver events > Search driver duty and location events with paginated POST filters — driver, event type, date range, and load or trip context for HOS and telematics data. This endpoint provides detailed information about driver events that match the search criteria, enabling efficient tracking and management of driver-related activities. ### Request Parameters The following parameter is required in the URL path: | Parameter | Type | Required | Description | | --------- | ------ | -------- | ----------------------- | | version | String | Yes | The API version to use. | #### Request Body Parameters The following parameters are required in the request body: | Parameter | Type | Required | Description | | --------- | ----------------- | -------- | ----------------------------------------------- | | StartDate | String (DateTime) | Yes | The start date-time for the event search range. | | EndDate | String (DateTime) | No | The end date-time for the event search range. | | DriverIds | Array of Strings | Yes | The list of driver IDs to filter driver events. | #### Example CURL request Use the current API version number and ensure you replace the Authorization header value with your actual Bearer token for the request: ```bash theme={null} curl --location 'https://integrations.alvys.com/api/p/v1/drivers/events/search' \ --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \ --header 'Content-Type: application/json' \ --data '{ "StartDate": "2025-02-06T06:50:20.471Z", "EndDate": "2025-02-06T06:50:20.471Z", "DriverIds": [ "string" ] }' ``` ### Response Parameters The following table lists the parameters included in the response for driver events requests. | Parameter | Type | Required | Description | | --------------- | ----------------- | -------- | --------------------------------------------------- | | Id | String | Yes | The unique identifier of the driver event. | | DriverId | String | Yes | The unique identifier of the driver. | | EventType | String | Yes | The type of event (e.g., Vacation, Restart, Other). | | Description | String | No | A detailed description of the event. | | StartDate | String (DateTime) | Yes | The start date-time of the event. | | EndDate | String (DateTime) | Yes | The end date-time of the event. | | Address | Object | No | The location details associated with the event. | | Address.Street | String | No | The street address where the event occurred. | | Address.City | String | No | The city where the event took place. | | Address.State | String | No | The state where the event took place. | | Address.ZipCode | String | No | The ZIP code of the event location. | | CreatedBy | String | Yes | The user who created the event record. | | CreatedAt | String (DateTime) | Yes | The timestamp for when the event was created. | #### Versioning The version parameter in the URL path specifies which version of the API you are using. Including the version number ensures that your application interacts with the correct version of the API, providing stability and compatibility as the API evolves. For more information on how versioning works and how to include it in your requests, please refer to the [Versioning](/docs/versioning) page. #### Example Response On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code. #### Rate Limits All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the [Rate Limits](/docs/rate-limits) section. This page is interactive, allowing you to try a request by specifying the API version in the URL path and providing the necessary request body. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can fork our [Public API Postman Collection](https://app.getpostman.com/run-collection/39138316-54c493c3-15e5-4fd7-a651-6e45b308548f?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D39138316-54c493c3-15e5-4fd7-a651-6e45b308548f%26entityType%3Dcollection%26workspaceId%3Dc0255544-5964-4c52-9d24-05b30a9b021c) directly. Make sure to authorize yourself before trying a request. ## OpenAPI ````yaml POST /api/p/v{version}/drivers/events/search openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/drivers/events/search: post: tags: - Drivers summary: Search driver events parameters: - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' requestBody: content: application/json-patch+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Users.DriverEventSearchRequest application/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Users.DriverEventSearchRequest text/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Users.DriverEventSearchRequest application/*+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Users.DriverEventSearchRequest required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DriverResponse' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Users.DriverEventSearchRequest: required: - DriverIds - StartDate type: object properties: StartDate: type: string format: date-time EndDate: type: string format: date-time nullable: true DriverIds: type: array items: type: string additionalProperties: false DriverResponse: required: - CreatedAt - Id - IsActive - Name - Notes - Status - SubsidiaryId - Type type: object properties: Id: type: string EmployeeId: type: string nullable: true PhoneNumber: type: string nullable: true UserId: type: string nullable: true Email: type: string nullable: true Name: type: string Type: type: string SubsidiaryId: type: string Address: allOf: - $ref: '#/components/schemas/Alvys.Features.Locations.ShortAddress' nullable: true Status: type: string LicenseNum: type: string nullable: true LicenseState: type: string nullable: true LicenseCountry: type: string nullable: true LicenseExpiresAt: type: string format: date-time nullable: true MedicalExpiresAt: type: string format: date-time nullable: true HiredAt: type: string format: date-time nullable: true TerminatedAt: type: string format: date-time nullable: true Notes: type: array items: $ref: '#/components/schemas/Alvys.Models.Notes.NoteDto' Fleet: allOf: - $ref: '#/components/schemas/FleetResponse' nullable: true CreatedAt: type: string format: date-time IsActive: type: boolean References: type: array items: $ref: '#/components/schemas/Alvys.Models.References.ReferenceResponse' nullable: true additionalProperties: false Microsoft.AspNetCore.Mvc.ValidationProblemDetails: required: - Errors type: object properties: Errors: type: object additionalProperties: type: array items: type: string Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Alvys.Features.Locations.ShortAddress: required: - City - State - Street - ZipCode type: object properties: Street: type: string City: type: string State: type: string ZipCode: type: string additionalProperties: false Alvys.Models.Notes.NoteDto: required: - Description - id - NoteType - User type: object properties: id: type: string Description: type: string NoteType: type: string Time: type: string format: date-time nullable: true User: type: string UserId: type: string nullable: true additionalProperties: false FleetResponse: type: object properties: Id: type: string nullable: true Name: type: string nullable: true InvoiceNumberPrefix: type: string nullable: true additionalProperties: false Alvys.Models.References.ReferenceResponse: required: - Name - Value type: object properties: Id: type: string nullable: true ReferenceId: type: string nullable: true Name: type: string Value: type: string Type: type: string nullable: true Access: type: string nullable: true Origin: type: string nullable: true additionalProperties: false securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as `Authorization: Bearer `. ````