Read the authorised user's Fleetkeep profile and approved driver guidance.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/fleetkeep-co-uk:fleetkeep-co-uk-account-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fleetkeep Co Uk Account 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 Account 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: Account
description: Read the authorised user's Fleetkeep profile and approved driver guidance.
paths:
/api/v1/setup:
get:
tags:
- Account
summary: Check fleet setup and the next onboarding step
description: Read this first when setting up Fleetkeep. Available before purchase. Returns subscription access, trial end, vehicle count, email consent and secure website links. Does not start a trial, take payment or change records. Keep existing subscriptions; never ask for card details. Preview supplied spreadsheets and obtain confirmation before applying. Re-read after each website step.
operationId: getSetupStatus
security:
- oauth2:
- profile:read
responses:
'200':
description: Account-scoped setup status and next action
content:
application/json:
schema:
type: object
required:
- nextStep
- vehicleCount
- canUseApi
- billing
- emailRemindersEnabled
- nextAction
- paymentNote
- links
properties:
nextStep:
type: string
enum:
- plan
- fleet_access
- vehicles
- reminders
- review
vehicleCount:
type: integer
minimum: 0
canUseApi:
type: boolean
billing:
type: object
description: Current active, plan, status, source, trialEligible, trialEndsAt, vehicleLimit and paymentMethodAdded values. No payment credentials.
emailRemindersEnabled:
type: boolean
nextAction:
type: string
paymentNote:
type: string
links:
type: object
additionalProperties:
type: string
format: uri
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
servers:
- url: https://fleetkeep.co.uk
description: Production
/api/v1/profile:
get:
tags:
- Account
summary: Read the authorised user's Fleetkeep profile
operationId: getProfile
security:
- oauth2:
- profile:read
responses:
'200':
description: Closed account profile
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileEnvelope'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/BillingRequired'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/ServiceMisconfigured'
servers:
- url: https://fleetkeep.co.uk
description: Production
/api/v1/driver-guidance:
get:
tags:
- Account
summary: Read approved driver guidance and safe document metadata
operationId: getDriverGuidance
security:
- oauth2:
- guidance:read
responses:
'200':
description: Guidance exists or a truthful disabled empty state
content:
application/json:
schema:
$ref: '#/components/schemas/DriverGuidanceEnvelope'
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/BillingRequired'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/ServiceMisconfigured'
servers:
- url: https://fleetkeep.co.uk
description: Production
/api/v1/driver-guidance/document:
get:
tags:
- Account
summary: Download the authorised user's private driver-guidance document
operationId: downloadDriverGuidanceDocument
security:
- oauth2:
- guidance:read
responses:
'200':
description: Private no-store document body
content:
application/octet-stream:
schema:
type: string
format: binary
'401':
$ref: '#/components/responses/Unauthorized'
'402':
$ref: '#/components/responses/BillingRequired'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimited'
'503':
$ref: '#/components/responses/ServiceUnavailable'
'500':
$ref: '#/components/responses/ServiceMisconfigured'
servers:
- url: https://fleetkeep.co.uk
description: Production
components:
responses:
Unauthorized:
description: Missing or invalid Bearer access token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource does not exist on the authorised user's account, is the wrong event type, or is immutable history for this operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
BillingRequired:
description: The authorised Fleetkeep account does not currently have active product access.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
RateLimited:
description: Per-token rate limit exceeded (60 requests per minute).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ServiceMisconfigured:
description: The API authentication or database service is not configured.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ServiceUnavailable:
description: A required private storage, provider configuration or service dependency is unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Forbidden:
description: Token does not include the required scope.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
additionalProperties: false
required:
- error
properties:
error:
type: string
example: registration_required
DriverGuidanceEnvelope:
type: object
additionalProperties: false
required:
- guidance
properties:
guidance:
type: object
additionalProperties: false
required:
- enabled
- breakdownInfo
- accidentProcedure
- vehicleGuidance
- document
- updatedAt
properties:
enabled:
type: boolean
breakdownInfo:
type: string
maxLength: 5000
accidentProcedure:
type: string
maxLength: 5000
vehicleGuidance:
type: string
maxLength: 5000
document:
oneOf:
- $ref: '#/components/schemas/DriverGuidanceDocument'
- type: 'null'
updatedAt:
type:
- string
- 'null'
format: date-time
DriverGuidanceDocument:
type: object
additionalProperties: false
required:
- fileName
- sizeBytes
- contentType
- uploadedAt
- downloadPath
properties:
fileName:
type:
- string
- 'null'
maxLength: 255
sizeBytes:
type:
- integer
- 'null'
minimum: 1
maximum: 10485760
contentType:
type:
- string
- 'null'
maxLength: 120
uploadedAt:
type:
- string
- 'null'
format: date-time
downloadPath:
type: string
const: /api/v1/driver-guidance/document
ProfileEnvelope:
type: object
additionalProperties: false
required:
- profile
properties:
profile:
type: object
additionalProperties: false
required:
- name
- email
- createdAt
- updatedAt
properties:
name:
type:
- string
- 'null'
maxLength: 120
email:
type: string
format: email
maxLength: 320
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
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)