Saltar al contenido principal

List company vehicle fleet with pagination

GET 
/company/vehicles/

Retrieves the authenticated company's complete vehicle fleet with pagination, search, and filtering capabilities.

Objective​

Enable companies to manage their fleet by viewing, searching, and paginating through all registered vehicles.

Use Cases​

  • Display paginated list of all company vehicles in fleet management interface
  • Search for specific vehicles by license plate
  • Use autocomplete for quick vehicle lookup
  • Retrieve default vehicle for digital signature operations

Validation Flow​

flowchart TD
  A[Receive Request] --> B{User Authenticated?}
  B -->|No| C[401 Unauthorized]
  B -->|Yes| D{User Has Company?}
  D -->|No| E[401 CIA_NOT_FOUND]
  D -->|Yes| F[Get Company Vehicles]
  F --> G{Apply Filters}
  G --> H[Paginate Results]
  H --> I{isSign = true?}
  I -->|Yes| J[Include Default Vehicle]
  I -->|No| K[Return Paginated List]
  J --> K

Pagination​

The response uses custom pagination format with metadata including:

  • docs: Array of vehicle objects
  • totalDocs: Total number of matching vehicles
  • page: Current page number
  • limit: Results per page
  • totalPages: Total number of pages
  • hasNextPage/hasPrevPage: Navigation flags
  • nextPage/prevPage: Page numbers for navigation

Search Behavior​

Both search and autocomplete parameters filter vehicles by license plate using case-insensitive regex matching.

Request​

Responses​

Fleet list retrieved successfully

Response Headers