Fleetkeep Jobs API

openapi: 3.2.0
info:
  title: Fleetkeep Co Uk Jobs 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 Jobs 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: Jobs
paths:
  /api/v1/jobs/import:
    post:
      operationId: importProviderJobs
      summary: Preview or apply a caller-authorised ServiceM8 or Simpro job import
      description: Use the owner's saved connection with useSavedConnection=true, or supply a current provider accessToken for this request only. Set up saved connections at /dashboard/jobs/connections. Reads up to 5,000 jobs over at most 20 pages within 30 seconds. Apply re-reads the provider and requires the exact preview digest. Missing jobs remain unchanged; existing locally closed jobs stay closed. No provider data writes or background polling.
      security:
      - oauth2:
        - operations:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - provider
              - action
              anyOf:
              - required:
                - useSavedConnection
                properties:
                  useSavedConnection:
                    const: true
              - required:
                - accessToken
              properties:
                useSavedConnection:
                  type: boolean
                  description: Use only the authenticated owner's saved provider source and grant.
                provider:
                  enum:
                  - servicem8
                  - simpro
                action:
                  enum:
                  - preview
                  - apply
                accessToken:
                  type: string
                  writeOnly: true
                  maxLength: 8192
                origin:
                  type: string
                  description: 'Required for Simpro with a caller-supplied token: exact HTTPS build origin on simprosuite.com or simprocloud.com. Ignored for saved connections.'
                companyId:
                  type: integer
                  minimum: 0
                  description: Required for Simpro with a caller-supplied token. Ignored for saved connections.
                digest:
                  type: string
                  pattern: ^[a-f0-9]{64}$
                  description: Required when action is apply.
      responses:
        '200':
          description: Preview jobs and digest, or imported row count after confirmation. Count includes updates and idempotent retries.
        '400':
          description: Invalid provider, destination, token or confirmation.
        '401':
          description: Fleetkeep authorisation required.
        '403':
          description: Fleet plan or scope required.
        '409':
          description: Reconnect provider, changed preview, conflicting reference or read limit reached.
        '429':
          description: Provider rate limit reached. No automatic retry.
        '502':
          description: Provider unavailable or unsupported response. No partial import applied.
      tags:
      - Jobs
    servers:
    - url: https://fleetkeep.co.uk
      description: Production
  /api/v1/jobs:
    get:
      operationId: listFleetJobs
      summary: List the fleet owner's jobs. Requires an active Fleet plan
      security:
      - oauth2:
        - operations:read
      parameters:
      - name: q
        in: query
        schema:
          type: string
          maxLength: 120
      responses:
        '200':
          description: jobs array and hasMore flag; at most 250 matches
      tags:
      - Jobs
    post:
      operationId: saveFleetJob
      summary: Save a shared job reference, or close/reopen a job owned by the caller
      security:
      - oauth2:
        - operations:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                required:
                - action
                - reference
                - title
                properties:
                  action:
                    const: save
                  reference:
                    type: string
                    maxLength: 120
                  title:
                    type: string
                    maxLength: 120
              - type: object
                required:
                - action
                - id
                - status
                properties:
                  action:
                    const: status
                  id:
                    type: string
                    format: uuid
                  status:
                    enum:
                    - active
                    - closed
      responses:
        '200':
          description: Saved job. Reusing a reference updates the title without reopening it.
      tags:
      - Jobs
    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)