Fleetkeep Driver Workspace API

openapi: 3.2.0
info:
  title: Fleetkeep Co Uk Driver Workspace API
  version: 0.8.0
  contact:
    name: Fleetkeep partner integration
    url: https://fleetkeep.co.uk/contact
    email: hello@fleetkeep.co.uk
  license:
    name: Proprietary
    url: https://fleetkeep.co.uk/legal/terms
  description: 'Operations tagged Driver Workspace across 2 of this provider''s published API definitions: openapi.json, fleetkeep-co-uk-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://fleetkeep.co.uk
  description: Production
security:
- oauth2:
  - vehicles:read
tags:
- name: Driver Workspace
paths:
  /api/v1/driver-workspace/{id}/jobs:
    get:
      operationId: listDriverJobs
      summary: Active jobs for the caller's accepted driver membership.
      security:
      - oauth2:
        - operations:read
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: q
        in: query
        schema:
          type: string
          maxLength: 120
      responses:
        '200':
          description: jobs array with id, reference and title; hasMore flags additional matches
      tags:
      - Driver Workspace
    servers:
    - url: https://fleetkeep.co.uk
      description: Production
  /api/v1/driver-workspace:
    get:
      operationId: listDriverMemberships
      summary: List your driver memberships
      security:
      - oauth2:
        - vehicles:read
      responses:
        '200':
          description: Authorised account data
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Authentication required
        '403':
          description: Access denied
      tags:
      - Driver Workspace
    servers:
    - url: https://fleetkeep.co.uk
      description: Production
  /api/v1/driver-workspace/{id}:
    get:
      operationId: getDriverWorkspace
      summary: Read your authorised driver workspace
      security:
      - oauth2:
        - operations:read
      responses:
        '200':
          description: Authorised account data
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Authentication required
        '403':
          description: Access denied
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyFormat
        in: query
        description: Use distance-v1 to include map/manual records with nullable odometer readings. When distanceRecord is present, its journeyDate is the travel day; startedAt/endedAt are entry timestamps, not driving times. Omit this parameter for legacy odometer-only records.
        schema:
          type: string
          enum:
          - distance-v1
      tags:
      - Driver Workspace
    servers:
    - url: https://fleetkeep.co.uk
      description: Production
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.1 authorisation-code flow with PKCE (S256). End-user delegates per-vehicle access to a partner client. Access tokens expire after 1 hour; refresh tokens (granted with the offline_access scope) live for 30 days.
      flows:
        authorizationCode:
          authorizationUrl: https://fleetkeep.co.uk/auth/oauth2/authorize
          tokenUrl: https://fleetkeep.co.uk/auth/oauth2/token
          refreshUrl: https://fleetkeep.co.uk/auth/oauth2/token
          scopes:
            vehicles:read: Read the authorised user's vehicles and compliance dates.
            vehicles:write: Add, update, delete and bulk-add vehicles on the authorised user's behalf.
            maintenance:read: Read the authorised user's maintenance tasks and completed history.
            maintenance:write: Create, update, complete and cancel the authorised user's maintenance tasks.
            operations:read: Read the authorised user's tracking snapshots, Wex route data and operational defect records.
            operations:write: Report and complete defects on the authorised user's behalf.
            tolls:read: Read the authorised user's toll and clean-air account records, charges and statement previews.
            tolls:write: Create toll and clean-air records and apply confirmed statement imports on the authorised user's behalf.
            documents:read: List and download the authorised user's private vehicle documents.
            documents:write: Create private vehicle document records and uploads on the authorised user's behalf.
            reminders:read: Read reminder settings and contacts.
            reminders:write: Manage reminder settings and contacts, and explicitly confirm verification sends.
            profile:read: Read the authorised user's Fleetkeep account profile.
            guidance:read: Read the authorised user's approved driver guidance and private guidance document.
            exports:read: Download the authorised user's private account and fleet spreadsheet exports.
            offline_access: Issue a refresh token so the partner can refresh access without re-prompting the user.
x-refined-from:
- openapi.json
- fleetkeep-co-uk-openapi.json
x-provenance:
  method: harvested
  publisher: Fleetkeep
  source: https://fleetkeep.co.uk/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)