Select API

Select SDK

Currently viewing: API docs

Customer API

Customer-facing API for self-service vehicle management and support.

Base URLhttps://customer-api.fleetflow.io

Quick setup

Create an OAuth application

Go to your organization's Developer Portal to create an OAuth app for customer authentication.

Configure redirect URIs

Add your application's callback URL (e.g., https://yourapp.com/callback) to the allowed redirect URIs in your OAuth app settings.

Copy your credentials

Copy your Client ID and Client Secret from the OAuth app details page. You'll also find your organization's API Key in the Developer Portal.

Implement OAuth flow

Use the OAuth 2.0 Authorization Code flow with PKCE to authenticate users and obtain access tokens.

Dashboard access

Open account developer →

Rate limits

API requests are rate limited to 1,000 requests per minute per organization. Contact support if you need higher limits for your use case.

OAuth 2.0

FleetFlow uses OAuth 2.0 with PKCE (Proof Key for Code Exchange) for secure authentication. Customers authenticate through your application to access their account data.

Getting your credentials

Client ID

A unique identifier for your OAuth application. Found in the OAuth app details page.

Client Secret

A secret key for your app. Keep this secure and never expose it in client-side code.

Redirect URI

Your app's callback URL where users are redirected after authentication.

OAuth endpoints

Authorization endpointhttps://auth.fleetflow.io/oauth/authorize

Token endpointhttps://auth.fleetflow.io/api/better-auth/oauth2/token

Supported scopes: openid profile email

Authorization Code Flow with PKCE

Generate PKCE parameters

Create a random code verifier and derive the code challenge using SHA-256.

Redirect to authorization

Send the user to the authorization endpoint with your client ID, redirect URI, and code challenge.

User authenticates

The user signs in and grants permission. They're redirected back with an authorization code.

Exchange code for tokens

POST the authorization code and code verifier to the token endpoint to receive access and refresh tokens.

Step 1-2: Build authorization URL

const authUrl = new URL('https://auth.fleetflow.io/oauth/authorize');
authUrl.searchParams.set('response_type', 'code');
authUrl.searchParams.set('client_id', CLIENT_ID);
authUrl.searchParams.set('redirect_uri', REDIRECT_URI);
authUrl.searchParams.set('scope', 'openid profile email');
authUrl.searchParams.set('code_challenge', codeChallenge);
authUrl.searchParams.set('code_challenge_method', 'S256');
authUrl.searchParams.set('state', state);

window.location.href = authUrl.toString();

Step 4: Exchange code for tokens

curl -X POST "https://auth.fleetflow.io/api/better-auth/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=authorization_code" \
  -d "code=AUTHORIZATION_CODE" \
  -d "code_verifier=CODE_VERIFIER" \
  -d "redirect_uri=REDIRECT_URI" \
  -d "client_id=CLIENT_ID"

Making authenticated requests

Once you have an access token, include it in the Authorization header of every API request. You must also include your organization's API key in the X-Api-Key header.

Required headers

AuthorizationRequired

Your OAuth access token prefixed with Bearer. Access tokens expire after a short period and must be refreshed.

X-Api-KeyRequired

Your organization's API key. Find this in the Developer Portal under OAuth Apps. This identifies which organization the request is for.

Content-TypeRecommended

Set to application/json for requests with a JSON body.

Token refresh

Access tokens expire after a short period. Use your refresh token to obtain a new access token without requiring the user to re-authenticate.

Important: Store refresh tokens securely. They allow obtaining new access tokens and should never be exposed in client-side code or logs.

Example API request

curl -X GET "https://customer-api.fleetflow.io/v1/vehicles" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
  -H "X-Api-Key: org_k3y_abc123def456" \
  -H "Content-Type: application/json"

Refreshing an access token

curl -X POST "https://auth.fleetflow.io/api/better-auth/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=refresh_token" \
  -d "refresh_token=REFRESH_TOKEN" \
  -d "client_id=CLIENT_ID"

Token response

{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "dGhpcyBpcyBhIHJlZnJl...",
  "scope": "openid profile email"
}

Account

Operations related to account

4 endpoints

GET/v5/account/

List Account

Returns a list of account for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Account retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/account/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").account().get();

POST/v5/account/

Create Account

Creates a new account and returns the created record.

Request Body

Name	Type	Description
`first_name`	`string`	-max: 256
`last_name`	`string`	-max: 256
`email`	`string (email)`	-max: 256
`phone`	`string (phone)`nullable	Phone number in E.164 format
`password`required	`string (password)`	-max: 256
`image`	`string (binary)`	Image file upload

Responses

200Account created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/account/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "your_password"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/account/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "password": "your_password"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/account/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "password": "your_password"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").account().post({
    "password": "your_password"
  });

PATCH/v5/account/

Update Account

Updates account configuration for the authenticated organization and returns the updated state.

Request Body

Name	Type	Description
`first_name`	`string`	-max: 256
`last_name`	`string`	-max: 256
`email`	`string (email)`	-max: 256
`phone`	`string (phone)`nullable	Phone number in E.164 format
`password`	`string (password)`	-max: 256
`tos_version_accepted`	`string`nullable	-max: 256
`privacy_version_accepted`	`string`nullable	-max: 256
`ride_history_consent`	`any`nullable	-
`leaderboard_consent`	`any`nullable	-
`marketing_email_consent`	`any`nullable	-
`marketing_push_consent`	`any`nullable	-
`image`	`string (binary)`	Image file upload

Responses

200Account updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/account/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/account/", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "first_name": "your_first_name",
      "last_name": "your_last_name",
      "email": "user@example.com"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/account/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "email": "user@example.com"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").account().patch({
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").account().patch([
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("account", mapOf(
    "first_name" to "your_first_name",
    "last_name" to "your_last_name",
    "email" to "user@example.com"
))

DELETE/v5/account/

Delete Account

Deletes account configuration for the authenticated organization and returns a confirmation payload.

Responses

200Account deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/account/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").account().delete();

Articles

Operations related to articles

3 endpoints

GET/v5/articles/

List Articles

Returns a list of articles for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-
`url`	`string`	-

Responses

200Articles retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/articles/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").articles().get();

GET/v5/articles/{uuid1}

Retrieve Article

Returns the requested article identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Article retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/articles/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/articles/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/articles/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").articles()("550e8400-e29b-41d4-a716-446655440000").get();

POST/v5/articles/{uuid1}/reviews/

Create Review

Creates a new review and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`stars`required	`integer`	-
`review`	`string`nullable	-max: 256

Responses

200Review created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/articles/550e8400-e29b-41d4-a716-446655440000/reviews/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stars": 1
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/articles/550e8400-e29b-41d4-a716-446655440000/reviews/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "stars": 1
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/articles/550e8400-e29b-41d4-a716-446655440000/reviews/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "stars": 1
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").articles()("550e8400-e29b-41d4-a716-446655440000").reviews().post({
    "stars": 1
  });

Auth

Operations related to auth

6 endpoints

GET/v5/auth/

List Auth

Returns a list of auth for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Auth retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/auth/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").auth().get();

GET/v5/auth/magic/email/

List Email

Returns a list of email for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`first_name`	`string`	-
`last_name`	`string`	-
`email`required	`string (email)`	-

Responses

200Email retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/auth/magic/email/?email=user%40example.com" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/auth/magic/email/?email=user%40example.com", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/auth/magic/email/?email=user%40example.com",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").auth().magic().email().get({
    "email": "user@example.com"
  });

POST/v5/auth/magic/email/

Create Email

Creates a new email and returns the created record.

Request Body

Name	Type	Description
`email`required	`string (email)`	-max: 256
`code`required	`string`	-max: 256

Responses

200Email created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/auth/magic/email/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "code": "your_code"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/auth/magic/email/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "email": "user@example.com",
      "code": "your_code"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/auth/magic/email/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "email": "user@example.com",
        "code": "your_code"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").auth().magic().email().post({
    "email": "user@example.com",
    "code": "your_code"
  });

GET/v5/auth/refresh/

List Refresh

Returns a list of refresh for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Refresh retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/auth/refresh/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/auth/refresh/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").auth().refresh().get();

POST/v5/auth/reset-password/

Create Reset-password

Creates a new reset-password and returns the created record.

Request Body

Name	Type	Description
`email`required	`string (email)`	-max: 256

Responses

200Reset-password created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/auth/reset-password/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/auth/reset-password/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "email": "user@example.com"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/auth/reset-password/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "email": "user@example.com"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").auth()["reset-password"]().post({
    "email": "user@example.com"
  });

PATCH/v5/auth/reset-password/

Update Reset-password

Updates reset-password configuration for the authenticated organization and returns the updated state.

Request Body

Name	Type	Description
`jwt`required	`string`	JSON Web Token
`password`required	`string (password)`	-max: 256

Responses

200Reset-password updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/auth/reset-password/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "jwt": "your_jwt",
    "password": "your_password"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/auth/reset-password/", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "jwt": "your_jwt",
      "password": "your_password"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/auth/reset-password/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "jwt": "your_jwt",
        "password": "your_password"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").auth()["reset-password"]().patch({
    "jwt": "your_jwt",
    "password": "your_password"
  });

Book Test Ride

Operations related to book test ride

4 endpoints

GET/v5/book_test_ride/availability/

List Availability

Returns a list of availability for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`partner_uuid`required	`string (uuid)`	-
`model_uuid`required	`string (uuid)`	-
`from_timestamp`	`string (date-time)`	-
`to_timestamp`	`string (date-time)`	-
`date`	`string (date)`	Date in YYYY-MM-DD format

Responses

200Availability retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/book_test_ride/availability/?partner_uuid=550e8400-e29b-41d4-a716-446655440000&model_uuid=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/book_test_ride/availability/?partner_uuid=550e8400-e29b-41d4-a716-446655440000&model_uuid=550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/book_test_ride/availability/?partner_uuid=550e8400-e29b-41d4-a716-446655440000&model_uuid=550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").book_test_ride().availability().get({
    "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid": "550e8400-e29b-41d4-a716-446655440000"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").book_test_ride().availability().get([
    "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid": "550e8400-e29b-41d4-a716-446655440000"
])

val api = fleetFlow.customer(version = "v5")

val response = api.get("book_test_ride/availability", mapOf(
    "partner_uuid" to "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid" to "550e8400-e29b-41d4-a716-446655440000"
))

POST/v5/book_test_ride/book/

Create Book

Creates a new book and returns the created record.

Request Body

Name	Type	Description
`partner_uuid`required	`string (uuid)`	-
`model_uuid`required	`string (uuid)`	-
`first_name`required	`string`nullable	-max: 256
`last_name`required	`string`nullable	-max: 256
`email`required	`string (email)`	-max: 256
`phone`required	`string (phone)`nullable	Phone number in E.164 format
`start_timestamp`	`string (date-time)`	-
`try_now`	`boolean`	-
`source`	`string`	-max: 256

Responses

200Book created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/book_test_ride/book/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com",
    "phone": "your_phone"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/book_test_ride/book/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
      "model_uuid": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "your_first_name",
      "last_name": "your_last_name",
      "email": "user@example.com",
      "phone": "your_phone"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/book_test_ride/book/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
        "model_uuid": "550e8400-e29b-41d4-a716-446655440000",
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "email": "user@example.com",
        "phone": "your_phone"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").book_test_ride().book().post({
    "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com",
    "phone": "your_phone"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").book_test_ride().book().post([
    "partner_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com",
    "phone": "your_phone"
])

val api = fleetFlow.customer(version = "v5")

val response = api.post("book_test_ride/book", mapOf(
    "partner_uuid" to "550e8400-e29b-41d4-a716-446655440000",
    "model_uuid" to "550e8400-e29b-41d4-a716-446655440000",
    "first_name" to "your_first_name",
    "last_name" to "your_last_name",
    "email" to "user@example.com",
    "phone" to "your_phone"
))

GET/v5/book_test_ride/models/

List Models

Returns a list of models for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Models retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/book_test_ride/models/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/book_test_ride/models/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").book_test_ride().models().get();

GET/v5/book_test_ride/partners/

List Partners

Returns a list of partners for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`no_limit`	`boolean`	-
`model_uuid`	`string (uuid)`	-

Responses

200Partners retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/book_test_ride/partners/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/book_test_ride/partners/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/book_test_ride/partners/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").book_test_ride().partners().get();

Clans

Operations related to clans

5 endpoints

GET/v5/clans/

List Clans

Returns a list of clans for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Clans retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/clans/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").clans().get();

POST/v5/clans/

Create Clan

Creates a new clan and returns the created record.

Request Body

Name	Type	Description
`clan_uuid`required	`string (uuid)`	-

Responses

200Clan created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/clans/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "clan_uuid": "550e8400-e29b-41d4-a716-446655440000"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/clans/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "clan_uuid": "550e8400-e29b-41d4-a716-446655440000"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/clans/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "clan_uuid": "550e8400-e29b-41d4-a716-446655440000"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").clans().post({
    "clan_uuid": "550e8400-e29b-41d4-a716-446655440000"
  });

GET/v5/clans/{uuid1}

Retrieve Clan

Returns the requested clan identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Clan retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").clans()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/clans/{uuid1}

Update Clan

Updates the requested clan identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Clan updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").clans()("550e8400-e29b-41d4-a716-446655440000").patch();

DELETE/v5/clans/{uuid1}

Delete Clan

Deletes the requested clan identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Clan deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/clans/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").clans()("550e8400-e29b-41d4-a716-446655440000").delete();

Collections

Operations related to collections

2 endpoints

GET/v5/collections/

List Collections

Returns a list of collections for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-
`url`	`string`	-

Responses

200Collections retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/collections/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").collections().get();

GET/v5/collections/{uuid1}

Retrieve Collection

Returns the requested collection identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Collection retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/collections/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/collections/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/collections/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").collections()("550e8400-e29b-41d4-a716-446655440000").get();

Diagnostics

Operations related to diagnostics

5 endpoints

GET/v5/diagnostics/sessions/

List Sessions

Returns a list of sessions for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Sessions retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/diagnostics/sessions/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/diagnostics/sessions/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").diagnostics().sessions().get();

POST/v5/diagnostics/sessions/

Create Session

Creates a new session and returns the created record.

Request Body

Name	Type	Description
`platform`required	`string`	-max: 50000
`version_name`required	`string`	-max: 50000
`version_code`	`string`nullable	-
`build_number`	`string`nullable	-max: 50000
`environment`	`string`nullable	-max: 50000
`started_at`	`string (date-time)`nullable	-
`network_type`	`string`nullable	-max: 50000
`app_start_ms`	`string`nullable	-

Responses

200Session created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/diagnostics/sessions/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "your_platform",
    "version_name": "your_version_name"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/diagnostics/sessions/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "platform": "your_platform",
      "version_name": "your_version_name"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/diagnostics/sessions/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "platform": "your_platform",
        "version_name": "your_version_name"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").diagnostics().sessions().post({
    "platform": "your_platform",
    "version_name": "your_version_name"
  });

GET/v5/diagnostics/sessions/{uuid1}

Retrieve Session

Returns the requested session identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Session retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").diagnostics().sessions()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/diagnostics/sessions/{uuid1}

Update Session

Updates the requested session identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`ended_at`	`string`nullable	-max: 50000
`crashed`	`boolean`nullable	-
`anr`	`boolean`nullable	-
`network_type`	`string`nullable	-max: 50000

Responses

200Session updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ended_at": "your_ended_at",
    "crashed": true,
    "anr": true
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "ended_at": "your_ended_at",
      "crashed": true,
      "anr": true
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "ended_at": "your_ended_at",
        "crashed": True,
        "anr": True
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").diagnostics().sessions()("550e8400-e29b-41d4-a716-446655440000").patch({
    "ended_at": "your_ended_at",
    "crashed": true,
    "anr": true
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").diagnostics().sessions()("550e8400-e29b-41d4-a716-446655440000").patch([
    "ended_at": "your_ended_at",
    "crashed": true,
    "anr": true
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("diagnostics/sessions/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "ended_at" to "your_ended_at",
    "crashed" to true,
    "anr" to true
))

POST/v5/diagnostics/events/

Create Event

Creates a new event and returns the created record.

Request Body

Name	Type	Description
`events`required	`any[]`	-

Responses

200Event created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/diagnostics/events/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "events": []
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/diagnostics/events/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "events": []
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/diagnostics/events/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "events": []
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").diagnostics().events().post({
    "events": []
  });

Export

Operations related to export

1 endpoint

GET/v5/export/

List Export

Returns a list of export for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Export retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/export/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").export().get();

Find

Operations related to find

1 endpoint

POST/v5/find/

Create Find

Creates a new find and returns the created record.

Request Body

Name	Type	Description
`hashes`required	`any[]`	-
`location_latitude`required	`number (float)`	Latitude or longitude coordinate
`location_longitude`required	`number (float)`	Latitude or longitude coordinate

Responses

200Find created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/find/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "hashes": [],
    "location_latitude": 10.5,
    "location_longitude": 10.5
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/find/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "hashes": [],
      "location_latitude": 10.5,
      "location_longitude": 10.5
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/find/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "hashes": [],
        "location_latitude": 10.5,
        "location_longitude": 10.5
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").find().post({
    "hashes": [],
    "location_latitude": 10.5,
    "location_longitude": 10.5
  });

Friendships

Operations related to friendships

5 endpoints

GET/v5/friendships/

List Friendships

Returns a list of friendships for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Friendships retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/friendships/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").friendships().get();

POST/v5/friendships/

Create Friendship

Creates a new friendship and returns the created record.

Request Body

Name	Type	Description
`customer_uuid`required	`string (uuid)`	-

Responses

200Friendship created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/friendships/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_uuid": "550e8400-e29b-41d4-a716-446655440000"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/friendships/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "customer_uuid": "550e8400-e29b-41d4-a716-446655440000"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/friendships/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "customer_uuid": "550e8400-e29b-41d4-a716-446655440000"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").friendships().post({
    "customer_uuid": "550e8400-e29b-41d4-a716-446655440000"
  });

GET/v5/friendships/{uuid1}

Retrieve Friendship

Returns the requested friendship identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Friendship retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").friendships()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/friendships/{uuid1}

Update Friendship

Updates the requested friendship identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`	`string`	-max: 256

Responses

200Friendship updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").friendships()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

DELETE/v5/friendships/{uuid1}

Delete Friendship

Deletes the requested friendship identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Friendship deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/friendships/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").friendships()("550e8400-e29b-41d4-a716-446655440000").delete();

Integrations

Operations related to integrations

4 endpoints

GET/v5/integrations/strava/

List Strava

Returns a list of strava for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Strava retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/integrations/strava/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/integrations/strava/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").integrations().strava().get();

DELETE/v5/integrations/strava/

Delete Strava

Deletes strava configuration for the authenticated organization and returns a confirmation payload.

Responses

200Strava deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/integrations/strava/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/integrations/strava/", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/integrations/strava/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").integrations().strava().delete();

GET/v5/integrations/strava/callback/

List Callback

Returns a list of callback for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Callback retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/integrations/strava/callback/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/integrations/strava/callback/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/integrations/strava/callback/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").integrations().strava().callback().get();

GET/v5/integrations/strava/start/

List Start

Returns a list of start for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Start retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/integrations/strava/start/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/integrations/strava/start/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/integrations/strava/start/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").integrations().strava().start().get();

Leaderboards

Operations related to leaderboards

5 endpoints

GET/v5/leaderboards/

List Leaderboards

Returns a list of leaderboards for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Leaderboards retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/leaderboards/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/leaderboards/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").leaderboards().get();

GET/v5/leaderboards/statistics

List Statistics

Returns a list of statistics for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Statistics retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/leaderboards/statistics" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/leaderboards/statistics", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/leaderboards/statistics",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").leaderboards().statistics().get();

GET/v5/leaderboards/vehicles

List Vehicles

Returns a list of vehicles for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Vehicles retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/leaderboards/vehicles" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/leaderboards/vehicles", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").leaderboards().vehicles().get();

GET/v5/leaderboards/customers

List Customers

Returns a list of customers for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Customers retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/leaderboards/customers" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/leaderboards/customers", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").leaderboards().customers().get();

GET/v5/leaderboards/clans

List Clans

Returns a list of clans for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Clans retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/leaderboards/clans" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/leaderboards/clans", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").leaderboards().clans().get();

Metadata

Operations related to metadata

4 endpoints

GET/v5/metadata/

List Metadata

Returns a list of metadata for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Metadata retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/metadata/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").metadata().get();

GET/v5/metadata/{uuid1}

Retrieve Metadata

Returns the requested metadata identified by its organization-defined key.

Path Parameters

Name	Type	Description
`uuid1`required	`string`	-

Responses

200Metadata retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").metadata()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/metadata/{uuid1}

Update Metadata

Updates the requested metadata identified by its organization-defined key and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string`	-

Request Body

Name	Type	Description
`value`required	`string`nullable	-

Responses

200Metadata updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "your_value"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "value": "your_value"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "value": "your_value"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").metadata()("550e8400-e29b-41d4-a716-446655440000").patch({
    "value": "your_value"
  });

DELETE/v5/metadata/{uuid1}

Delete Metadata

Deletes the requested metadata identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Metadata deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").metadata()("550e8400-e29b-41d4-a716-446655440000").delete();

Oauth Applications

Operations related to oauth applications

20 endpoints

GET/v5/oauth_applications/

List OAuth Applications

Returns a list of oauth applications for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200OAuth Applications retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications().get();

POST/v5/oauth_applications/

Create OAuth Application

Creates a new oauth application and returns the created record.

Request Body

Name	Type	Description
`name`required	`string`	-max: 256
`description`	`string`nullable	-max: 50000
`purpose_of_usage`required	`string`	-max: 50000
`legal_basis`	`string`nullable	-max: 50000
`data_type`	`string`nullable	-max: 50000
`is_gatekeeper`	`boolean`nullable	-

Responses

200OAuth Application created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/oauth_applications/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "your_name",
    "purpose_of_usage": "your_purpose_of_usage"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "name": "your_name",
      "purpose_of_usage": "your_purpose_of_usage"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/oauth_applications/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "name": "your_name",
        "purpose_of_usage": "your_purpose_of_usage"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications().post({
    "name": "your_name",
    "purpose_of_usage": "your_purpose_of_usage"
  });

GET/v5/oauth_applications/{uuid1}

Retrieve OAuth Application

Returns the requested oauth application identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200OAuth Application retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/oauth_applications/{uuid1}

Update OAuth Application

Updates the requested oauth application identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`name`	`string`	-max: 256
`description`	`string`nullable	-max: 50000
`purpose_of_usage`	`string`	-max: 50000
`legal_basis`	`string`nullable	-max: 50000
`data_type`	`string`nullable	-max: 50000
`is_gatekeeper`	`boolean`nullable	-

Responses

200OAuth Application updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "your_name"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "name": "your_name"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "name": "your_name"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").patch({
    "name": "your_name"
  });

DELETE/v5/oauth_applications/{uuid1}

Delete OAuth Application

Deletes the requested oauth application identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200OAuth Application deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/oauth_applications/{uuid1}/allowed_origins/

List Allowed Origins

Returns a list of allowed origins for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Allowed Origins retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins().get();

POST/v5/oauth_applications/{uuid1}/allowed_origins/

Create Allowed Origin

Creates a new allowed origin and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`origin`required	`string`	-max: 256

Responses

200Allowed Origin created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "your_origin"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "origin": "your_origin"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "origin": "your_origin"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins().post({
    "origin": "your_origin"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins().post([
    "origin": "your_origin"
])

GET/v5/oauth_applications/{uuid1}/allowed_origins/{uuid2}

Retrieve Allowed Origin

Returns the requested allowed origin identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Allowed Origin retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins()("550e8400-e29b-41d4-a716-446655440000").get()

PATCH/v5/oauth_applications/{uuid1}/allowed_origins/{uuid2}

Update Allowed Origin

Updates the requested allowed origin identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`origin`	`string`	-max: 256

Responses

200Allowed Origin updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "your_origin"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "origin": "your_origin"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "origin": "your_origin"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins()("550e8400-e29b-41d4-a716-446655440000").patch({
    "origin": "your_origin"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins()("550e8400-e29b-41d4-a716-446655440000").patch([
    "origin": "your_origin"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "origin" to "your_origin"
))

DELETE/v5/oauth_applications/{uuid1}/allowed_origins/{uuid2}

Delete Allowed Origin

Deletes the requested allowed origin identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Allowed Origin deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/allowed_origins/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").allowed_origins()("550e8400-e29b-41d4-a716-446655440000").delete()

GET/v5/oauth_applications/{uuid1}/redirect_uris/

List Redirect Uris

Returns a list of redirect uris for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Redirect Uris retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris().get();

POST/v5/oauth_applications/{uuid1}/redirect_uris/

Create Redirect Uri

Creates a new redirect uri and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`redirect_uri`required	`string`	-max: 256

Responses

200Redirect Uri created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "redirect_uri": "your_redirect_uri"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "redirect_uri": "your_redirect_uri"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "redirect_uri": "your_redirect_uri"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris().post({
    "redirect_uri": "your_redirect_uri"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris().post([
    "redirect_uri": "your_redirect_uri"
])

GET/v5/oauth_applications/{uuid1}/redirect_uris/{uuid2}

Retrieve Redirect Uri

Returns the requested redirect uri identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Redirect Uri retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris()("550e8400-e29b-41d4-a716-446655440000").get()

PATCH/v5/oauth_applications/{uuid1}/redirect_uris/{uuid2}

Update Redirect Uri

Updates the requested redirect uri identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`redirect_uri`	`string`	-max: 256

Responses

200Redirect Uri updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "redirect_uri": "your_redirect_uri"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "redirect_uri": "your_redirect_uri"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "redirect_uri": "your_redirect_uri"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris()("550e8400-e29b-41d4-a716-446655440000").patch({
    "redirect_uri": "your_redirect_uri"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris()("550e8400-e29b-41d4-a716-446655440000").patch([
    "redirect_uri": "your_redirect_uri"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "redirect_uri" to "your_redirect_uri"
))

DELETE/v5/oauth_applications/{uuid1}/redirect_uris/{uuid2}

Delete Redirect Uri

Deletes the requested redirect uri identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Redirect Uri deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/redirect_uris/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").redirect_uris()("550e8400-e29b-41d4-a716-446655440000").delete()

GET/v5/oauth_applications/{uuid1}/return_urls/

List Return Urls

Returns a list of return urls for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Return Urls retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls().get();

POST/v5/oauth_applications/{uuid1}/return_urls/

Create Return Url

Creates a new return url and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`return_url`required	`string`	-max: 256

Responses

200Return Url created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "your_return_url"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "return_url": "your_return_url"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "return_url": "your_return_url"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls().post({
    "return_url": "your_return_url"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls().post([
    "return_url": "your_return_url"
])

GET/v5/oauth_applications/{uuid1}/return_urls/{uuid2}

Retrieve Return Url

Returns the requested return url identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Return Url retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls()("550e8400-e29b-41d4-a716-446655440000").get()

PATCH/v5/oauth_applications/{uuid1}/return_urls/{uuid2}

Update Return Url

Updates the requested return url identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`return_url`	`string`	-max: 256

Responses

200Return Url updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "your_return_url"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "return_url": "your_return_url"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "return_url": "your_return_url"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls()("550e8400-e29b-41d4-a716-446655440000").patch({
    "return_url": "your_return_url"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls()("550e8400-e29b-41d4-a716-446655440000").patch([
    "return_url": "your_return_url"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "return_url" to "your_return_url"
))

DELETE/v5/oauth_applications/{uuid1}/return_urls/{uuid2}

Delete Return Url

Deletes the requested return url identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Return Url deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/oauth_applications/550e8400-e29b-41d4-a716-446655440000/return_urls/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").oauth_applications()("550e8400-e29b-41d4-a716-446655440000").return_urls()("550e8400-e29b-41d4-a716-446655440000").delete()

Orders

Operations related to orders

4 endpoints

GET/v5/orders/

List Orders

Returns a list of orders for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Orders retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/orders/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").orders().get();

GET/v5/orders/{uuid1}

Retrieve Order

Returns the requested order identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Order retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").orders()("550e8400-e29b-41d4-a716-446655440000").get();

GET/v5/orders/{uuid1}/line_items/

List Line Items

Returns a list of line items for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Line Items retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000/line_items/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000/line_items/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000/line_items/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").orders()("550e8400-e29b-41d4-a716-446655440000").line_items().get();

GET/v5/orders/{uuid1}/line_items/{uuid1}

Retrieve Line Item

Returns the requested line item identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Line Item retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000/line_items/{uuid1}" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000/line_items/{uuid1}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/orders/550e8400-e29b-41d4-a716-446655440000/line_items/{uuid1}",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").orders()("550e8400-e29b-41d4-a716-446655440000").line_items()("550e8400-e29b-41d4-a716-446655440000").get();

Ownership Requests

Operations related to ownership requests

4 endpoints

GET/v5/ownership_requests/

List Ownership Requests

Returns a list of ownership requests for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Ownership Requests retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/ownership_requests/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/ownership_requests/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").ownership_requests().get();

POST/v5/ownership_requests/

Create Ownership Request

Creates a new ownership request and returns the created record.

Request Body

Name	Type	Description
`vehicle_uuid`required	`string (uuid)`	-

Responses

200Ownership Request created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/ownership_requests/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/ownership_requests/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/ownership_requests/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").ownership_requests().post({
    "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000"
  });

GET/v5/ownership_requests/{uuid1}

Retrieve Ownership Request

Returns the requested ownership request identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Ownership Request retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/ownership_requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/ownership_requests/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/ownership_requests/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").get();

DELETE/v5/ownership_requests/{uuid1}

Delete Ownership Request

Deletes the requested ownership request identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Ownership Request deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/ownership_requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/ownership_requests/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/ownership_requests/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").delete();

Partners

Operations related to partners

5 endpoints

GET/v5/partners/

List Partners

Returns a list of partners for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Partners retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/partners/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").partners().get();

GET/v5/partners/{uuid1}

Retrieve Partner

Returns the requested partner identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Partner retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").partners()("550e8400-e29b-41d4-a716-446655440000").get();

GET/v5/partners/{uuid1}/test_rides/vehicles/

List Vehicles

Returns a list of vehicles for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Vehicles retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").partners()("550e8400-e29b-41d4-a716-446655440000").test_rides().vehicles().get();

POST/v5/partners/{uuid1}/test_rides/vehicles/

Create Vehicle

Creates a new vehicle and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`first_name`required	`string`nullable	-max: 256
`last_name`required	`string`nullable	-max: 256
`email`required	`string (email)`	-max: 256
`phone`required	`string (phone)`nullable	Phone number in E.164 format
`start_timestamp`	`string (date-time)`	-
`try_now`	`boolean`	-
`source`	`string`	-max: 256

Responses

200Vehicle created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com",
    "phone": "your_phone"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "first_name": "your_first_name",
      "last_name": "your_last_name",
      "email": "user@example.com",
      "phone": "your_phone"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "email": "user@example.com",
        "phone": "your_phone"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").partners()("550e8400-e29b-41d4-a716-446655440000").test_rides().vehicles().post({
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com",
    "phone": "your_phone"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").partners()("550e8400-e29b-41d4-a716-446655440000").test_rides().vehicles().post([
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "email": "user@example.com",
    "phone": "your_phone"
])

val api = fleetFlow.customer(version = "v5")

val response = api.post("partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles", mapOf(
    "first_name" to "your_first_name",
    "last_name" to "your_last_name",
    "email" to "user@example.com",
    "phone" to "your_phone"
))

GET/v5/partners/{uuid1}/test_rides/vehicles/{uuid1}

Retrieve Vehicle

Returns the requested vehicle identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`from_timestamp`	`string (date-time)`	-
`to_timestamp`	`string (date-time)`	-
`date`	`string (date)`	Date in YYYY-MM-DD format

Responses

200Vehicle retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/{uuid1}" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/{uuid1}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/partners/550e8400-e29b-41d4-a716-446655440000/test_rides/vehicles/{uuid1}",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").partners()("550e8400-e29b-41d4-a716-446655440000").test_rides().vehicles()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").partners()("550e8400-e29b-41d4-a716-446655440000").test_rides().vehicles()("550e8400-e29b-41d4-a716-446655440000").get()

Public

Operations related to public

2 endpoints

GET/v5/public/clans/

List Clans

Returns a list of clans for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Clans retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/public/clans/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/public/clans/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").public().clans().get();

GET/v5/public/clans/{uuid1}

Retrieve Clan

Returns the requested clan identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Clan retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/public/clans/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/public/clans/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/public/clans/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").public().clans()("550e8400-e29b-41d4-a716-446655440000").get();

Service Tickets

Operations related to service tickets

4 endpoints

GET/v5/service_tickets/

List Service Tickets

Returns a list of service tickets for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Service Tickets retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/service_tickets/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/service_tickets/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").service_tickets().get();

GET/v5/service_tickets/{uuid1}

Retrieve Service Ticket

Returns the requested service ticket identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Service Ticket retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").service_tickets()("550e8400-e29b-41d4-a716-446655440000").get();

GET/v5/service_tickets/{uuid1}/products/

List Products

Returns a list of products for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Products retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000/products/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000/products/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000/products/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").service_tickets()("550e8400-e29b-41d4-a716-446655440000").products().get();

GET/v5/service_tickets/{uuid1}/products/{uuid2}

Retrieve Product

Returns the requested product identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Product retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000/products/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000/products/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/service_tickets/550e8400-e29b-41d4-a716-446655440000/products/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").service_tickets()("550e8400-e29b-41d4-a716-446655440000").products()("550e8400-e29b-41d4-a716-446655440000").get();

Sessions

Operations related to sessions

3 endpoints

GET/v5/sessions/

List Sessions

Returns a list of sessions for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Sessions retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/sessions/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").sessions().get();

GET/v5/sessions/{uuid1}

Retrieve Session

Returns the requested session identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Session retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/sessions/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/sessions/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").sessions()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/sessions/{uuid1}

Update Session

Updates the requested session identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`apns_token`	`string`nullable	-max: 50000
`apns_environment`	`string`nullable	-max: 50000
`fcm_token`	`string`nullable	-max: 50000
`app_version`	`string`nullable	-max: 50000
`bundle_identifier`	`string`nullable	-max: 50000
`device_model`	`string`nullable	-max: 50000
`device_locale`	`string`nullable	-max: 50000
`os_version`	`string`nullable	-max: 50000

Responses

200Session updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "apns_token": "your_apns_token",
    "apns_environment": "your_apns_environment",
    "fcm_token": "your_fcm_token"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/sessions/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "apns_token": "your_apns_token",
      "apns_environment": "your_apns_environment",
      "fcm_token": "your_fcm_token"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/sessions/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "apns_token": "your_apns_token",
        "apns_environment": "your_apns_environment",
        "fcm_token": "your_fcm_token"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").sessions()("550e8400-e29b-41d4-a716-446655440000").patch({
    "apns_token": "your_apns_token",
    "apns_environment": "your_apns_environment",
    "fcm_token": "your_fcm_token"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").sessions()("550e8400-e29b-41d4-a716-446655440000").patch([
    "apns_token": "your_apns_token",
    "apns_environment": "your_apns_environment",
    "fcm_token": "your_fcm_token"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("sessions/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "apns_token" to "your_apns_token",
    "apns_environment" to "your_apns_environment",
    "fcm_token" to "your_fcm_token"
))

Shop

Operations related to shop

11 endpoints

GET/v5/shop/products/

List Products

Returns a list of products for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Products retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/products/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/products/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().products().get();

GET/v5/shop/products/{uuid1}

Retrieve Product

Returns the requested product identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Product retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").get();

GET/v5/shop/products/{uuid1}/variants/

List Variants

Returns a list of variants for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Variants retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").variants().get();

GET/v5/shop/products/{uuid1}/variants/{uuid2}

Retrieve Variant

Returns the requested variant identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Variant retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").variants()("550e8400-e29b-41d4-a716-446655440000").get();

GET/v5/shop/products/{uuid1}/variants/{uuid2}/prices/

List Prices

Returns a list of prices for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Prices retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").variants()("550e8400-e29b-41d4-a716-446655440000").prices().get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").variants()("550e8400-e29b-41d4-a716-446655440000").prices().get()

GET/v5/shop/products/{uuid1}/variants/{uuid2}/prices/{uuid3}

Retrieve Price

Returns the requested price identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-
`uuid3`required	`string (uuid)`	-

Responses

200Price retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").variants()("550e8400-e29b-41d4-a716-446655440000").prices()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").shop().products()("550e8400-e29b-41d4-a716-446655440000").variants()("550e8400-e29b-41d4-a716-446655440000").prices()("550e8400-e29b-41d4-a716-446655440000").get()

val api = fleetFlow.customer(version = "v5")

val response = api.get("shop/products/550e8400-e29b-41d4-a716-446655440000/variants/550e8400-e29b-41d4-a716-446655440000/prices/550e8400-e29b-41d4-a716-446655440000")

GET/v5/shop/checkout/{uuid1}

Retrieve Checkout

Returns the requested checkout identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Checkout retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().checkout()("550e8400-e29b-41d4-a716-446655440000").get();

POST/v5/shop/checkout/

Create Checkout

Creates a new checkout and returns the created record.

Request Body

Name	Type	Description
`items`required	`any[]`	-
`payment_method`required	`string`	-max: 256
`fulfillment_type`	`string`nullable	-max: 256
`shipping`	`object`nullable	-
`billing`	`object`nullable	-
`vehicle_uuid`	`string (uuid)`nullable	-
`pickup_location_uuid`	`string (uuid)`nullable	-
`pickup_scheduled_at`	`string`nullable	-max: 256
`notes`	`string`nullable	-max: 256

Responses

200Checkout created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/shop/checkout/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [],
    "payment_method": "your_payment_method"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/checkout/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "items": [],
      "payment_method": "your_payment_method"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/shop/checkout/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "items": [],
        "payment_method": "your_payment_method"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().checkout().post({
    "items": [],
    "payment_method": "your_payment_method"
  });

GET/v5/shop/checkout/{uuid1}/complete/

List Complete

Returns a list of complete for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`payment_intent`	`string`	-
`payment_intent_client_secret`	`string`	-
`setup_intent`	`string`	-
`setup_intent_client_secret`	`string`	-
`redirect_status`	`string`	-
`error`	`string`	-

Responses

200Complete retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/complete/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/complete/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/complete/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().checkout()("550e8400-e29b-41d4-a716-446655440000").complete().get();

POST/v5/shop/checkout/{uuid1}/confirm/

Create Confirm

Creates a new confirm and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`payment_intent_id`	`string`nullable	-max: 256
`payment_method_id`	`string`nullable	-max: 256
`token_id`	`string`nullable	-max: 256

Responses

200Confirm created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/confirm/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_intent_id": "your_payment_intent_id",
    "payment_method_id": "your_payment_method_id",
    "token_id": "your_token_id"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/confirm/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "payment_intent_id": "your_payment_intent_id",
      "payment_method_id": "your_payment_method_id",
      "token_id": "your_token_id"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/confirm/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "payment_intent_id": "your_payment_intent_id",
        "payment_method_id": "your_payment_method_id",
        "token_id": "your_token_id"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().checkout()("550e8400-e29b-41d4-a716-446655440000").confirm().post({
    "payment_intent_id": "your_payment_intent_id",
    "payment_method_id": "your_payment_method_id",
    "token_id": "your_token_id"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").shop().checkout()("550e8400-e29b-41d4-a716-446655440000").confirm().post([
    "payment_intent_id": "your_payment_intent_id",
    "payment_method_id": "your_payment_method_id",
    "token_id": "your_token_id"
])

val api = fleetFlow.customer(version = "v5")

val response = api.post("shop/checkout/550e8400-e29b-41d4-a716-446655440000/confirm", mapOf(
    "payment_intent_id" to "your_payment_intent_id",
    "payment_method_id" to "your_payment_method_id",
    "token_id" to "your_token_id"
))

GET/v5/shop/checkout/{uuid1}/ideal/

List Ideal

Returns a list of ideal for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`client_secret`required	`string`	-

Responses

200Ideal retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/ideal/?client_secret=your_client_secret" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/ideal/?client_secret=your_client_secret", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/shop/checkout/550e8400-e29b-41d4-a716-446655440000/ideal/?client_secret=your_client_secret",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").shop().checkout()("550e8400-e29b-41d4-a716-446655440000").ideal().get({
    "client_secret": "your_client_secret"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").shop().checkout()("550e8400-e29b-41d4-a716-446655440000").ideal().get([
    "client_secret": "your_client_secret"
])

Test Rides

Operations related to test rides

2 endpoints

DELETE/v5/test_rides/{uuid1}

Delete Test Ride

Deletes the requested test ride identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Test Ride deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/test_rides/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/test_rides/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/test_rides/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").test_rides()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/test_rides/{uuid1}/cancel/

List Cancel

Returns a list of cancel for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`token`required	`string`	JSON Web Token

Responses

200Cancel retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/test_rides/550e8400-e29b-41d4-a716-446655440000/cancel/?token=your_token" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/test_rides/550e8400-e29b-41d4-a716-446655440000/cancel/?token=your_token", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/test_rides/550e8400-e29b-41d4-a716-446655440000/cancel/?token=your_token",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").test_rides()("550e8400-e29b-41d4-a716-446655440000").cancel().get({
    "token": "your_token"
  });

Threads

Operations related to threads

10 endpoints

GET/v5/threads/

List Threads

Returns a list of threads for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Threads retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/threads/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads().get();

POST/v5/threads/

Create Thread

Creates a new thread and returns the created record.

Request Body

Name	Type	Description
`vehicle_uuid`	`string (uuid)`	-
`title`	`string`nullable	-max: 256
`force_no_ai`	`boolean`	-

Responses

200Thread created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/threads/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "your_title",
    "force_no_ai": true
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000",
      "title": "your_title",
      "force_no_ai": true
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/threads/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000",
        "title": "your_title",
        "force_no_ai": True
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads().post({
    "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "your_title",
    "force_no_ai": true
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").threads().post([
    "vehicle_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "your_title",
    "force_no_ai": true
])

val api = fleetFlow.customer(version = "v5")

val response = api.post("threads", mapOf(
    "vehicle_uuid" to "550e8400-e29b-41d4-a716-446655440000",
    "title" to "your_title",
    "force_no_ai" to true
))

GET/v5/threads/{uuid1}

Retrieve Thread

Returns the requested thread identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Thread retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/threads/{uuid1}

Update Thread

Updates the requested thread identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`	`string`	-max: 256

Responses

200Thread updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

DELETE/v5/threads/{uuid1}

Delete Thread

Deletes the requested thread identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Thread deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/threads/{uuid1}/messages/

List Messages

Returns a list of messages for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Messages retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").messages().get();

POST/v5/threads/{uuid1}/messages/

Create Message

Creates a new message and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`message`required	`string`	-max: 256

Responses

200Message created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "your_message"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "message": "your_message"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "message": "your_message"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").messages().post({
    "message": "your_message"
  });

GET/v5/threads/{uuid1}/messages/{uuid2}

Retrieve Message

Returns the requested message identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Message retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").messages()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/threads/{uuid1}/messages/{uuid2}

Update Message

Updates the requested message identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`message`	`string`	-max: 256

Responses

200Message updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "your_message"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "message": "your_message"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "message": "your_message"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").messages()("550e8400-e29b-41d4-a716-446655440000").patch({
    "message": "your_message"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").messages()("550e8400-e29b-41d4-a716-446655440000").patch([
    "message": "your_message"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "message" to "your_message"
))

DELETE/v5/threads/{uuid1}/messages/{uuid2}

Delete Message

Deletes the requested message identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Message deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/threads/550e8400-e29b-41d4-a716-446655440000/messages/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").threads()("550e8400-e29b-41d4-a716-446655440000").messages()("550e8400-e29b-41d4-a716-446655440000").delete();

Track

Operations related to track

1 endpoint

GET/v5/track/{uuid1}

Retrieve Track

Returns the requested track identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Track retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/track/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/track/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/track/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").track()("550e8400-e29b-41d4-a716-446655440000").get();

Translations

Operations related to translations

4 endpoints

GET/v5/translations/

List Translations

Returns a list of translations for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Translations retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/translations/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/translations/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").translations().get();

GET/v5/translations/{uuid1}

Retrieve Translation

Returns the requested translation identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Translation retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").translations()("550e8400-e29b-41d4-a716-446655440000").get();

GET/v5/translations/{uuid1}/keys/

List Keys

Returns a list of keys for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Keys retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000/keys/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000/keys/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000/keys/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").translations()("550e8400-e29b-41d4-a716-446655440000").keys().get();

GET/v5/translations/{uuid1}/keys/{uuid2}

Retrieve Key

Returns the requested key identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Key retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000/keys/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000/keys/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/translations/550e8400-e29b-41d4-a716-446655440000/keys/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").translations()("550e8400-e29b-41d4-a716-446655440000").keys()("550e8400-e29b-41d4-a716-446655440000").get();

Vehicle Invitations

Operations related to vehicle invitations

4 endpoints

GET/v5/vehicle_invitations/

List Vehicle Invitations

Returns a list of vehicle invitations for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Vehicle Invitations retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicle_invitations/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicle_invitations/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicle_invitations().get();

GET/v5/vehicle_invitations/{uuid1}

Retrieve Vehicle Invitation

Returns the requested vehicle invitation identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Vehicle Invitation retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicle_invitations()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicle_invitations/{uuid1}

Update Vehicle Invitation

Updates the requested vehicle invitation identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`required	`string`	-max: 256

Responses

200Vehicle Invitation updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicle_invitations()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

DELETE/v5/vehicle_invitations/{uuid1}

Delete Vehicle Invitation

Deletes the requested vehicle invitation identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Vehicle Invitation deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicle_invitations/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicle_invitations()("550e8400-e29b-41d4-a716-446655440000").delete();

Vehicles

Operations related to vehicles

61 endpoints

GET/v5/vehicles/

List Vehicles

Returns a list of vehicles for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Responses

200Vehicles retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/" \
  -H "Authorization: Bearer YOUR_TOKEN"

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles().get();

POST/v5/vehicles/

Create Vehicle

Creates a new vehicle and returns the created record.

Request Body

Name	Type	Description
`vin`	`string`	-max: 256
`serial_numbers`	`any[]`	-

Responses

200Vehicle created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vin": "your_vin",
    "serial_numbers": []
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "vin": "your_vin",
      "serial_numbers": []
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "vin": "your_vin",
        "serial_numbers": []
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles().post({
    "vin": "your_vin",
    "serial_numbers": []
  });

GET/v5/vehicles/{uuid1}

Retrieve Vehicle

Returns the requested vehicle identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Vehicle retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}

Update Vehicle

Updates the requested vehicle identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`name`	`string`	-max: 256
`odometer`	`integer`	-
`ble_hash`	`string`nullable	-max: 256
`location_latitude`	`number (float)`	Latitude or longitude coordinate
`location_longitude`	`number (float)`	Latitude or longitude coordinate
`location_accuracy`	`integer`nullable	-
`geofence_latitude`	`number (float)`nullable	Latitude or longitude coordinate
`geofence_longitude`	`number (float)`nullable	Latitude or longitude coordinate
`geofence_radius`	`integer`nullable	-
`locked`	`boolean`	-
`alarm_enabled`	`boolean`	-
`status`	`string`	-max: 256
`image`	`string (binary)`	Image file upload

Responses

200Vehicle updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "your_name"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "name": "your_name"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "name": "your_name"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").patch({
    "name": "your_name"
  });

DELETE/v5/vehicles/{uuid1}

Delete Vehicle

Deletes the requested vehicle identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Vehicle deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/vehicles/{uuid1}/components/

List Components

Returns a list of components for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Components retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components().get();

GET/v5/vehicles/{uuid1}/components/{uuid2}

Retrieve Component

Returns the requested component identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Component retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}/components/{uuid2}

Update Component

Updates the requested component identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`serial_number`	`string`nullable	-max: 256
`firmware_version`	`string`nullable	-max: 256

Responses

200Component updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "serial_number": "your_serial_number",
    "firmware_version": "your_firmware_version"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "serial_number": "your_serial_number",
      "firmware_version": "your_firmware_version"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "serial_number": "your_serial_number",
        "firmware_version": "your_firmware_version"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").patch({
    "serial_number": "your_serial_number",
    "firmware_version": "your_firmware_version"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").patch([
    "serial_number": "your_serial_number",
    "firmware_version": "your_firmware_version"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "serial_number" to "your_serial_number",
    "firmware_version" to "your_firmware_version"
))

GET/v5/vehicles/{uuid1}/components/{uuid2}/firmwares/

List Firmwares

Returns a list of firmwares for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Firmwares retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").firmwares().get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").firmwares().get()

GET/v5/vehicles/{uuid1}/components/{uuid2}/firmwares/{uuid3}

Retrieve Firmware

Returns the requested firmware identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-
`uuid3`required	`string (uuid)`	-

Responses

200Firmware retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").firmwares()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").firmwares()("550e8400-e29b-41d4-a716-446655440000").get()

val api = fleetFlow.customer(version = "v5")

val response = api.get("vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000")

PATCH/v5/vehicles/{uuid1}/components/{uuid2}/firmwares/{uuid3}

Update Firmware

Updates the requested firmware identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-
`uuid3`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`	`string`	-max: 256

Responses

200Firmware updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").firmwares()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").firmwares()("550e8400-e29b-41d4-a716-446655440000").patch([
    "status": "your_status"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/firmwares/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "status" to "your_status"
))

GET/v5/vehicles/{uuid1}/components/{uuid2}/metadata/

List Metadata

Returns a list of metadata for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Metadata retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata().get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata().get()

GET/v5/vehicles/{uuid1}/components/{uuid2}/metadata/{uuid3}

Retrieve Metadata

Returns the requested metadata identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-
`uuid3`required	`string (uuid)`	-

Responses

200Metadata retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").get()

val api = fleetFlow.customer(version = "v5")

val response = api.get("vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000")

PATCH/v5/vehicles/{uuid1}/components/{uuid2}/metadata/{uuid3}

Update Metadata

Updates the requested metadata identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-
`uuid3`required	`string (uuid)`	-

Responses

200Metadata updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").patch();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").patch()

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000")

DELETE/v5/vehicles/{uuid1}/components/{uuid2}/metadata/{uuid3}

Delete Metadata

Deletes the requested metadata identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-
`uuid3`required	`string (uuid)`	-

Responses

200Metadata deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").components()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").delete()

val api = fleetFlow.customer(version = "v5")

val response = api.delete("vehicles/550e8400-e29b-41d4-a716-446655440000/components/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000")

GET/v5/vehicles/{uuid1}/customer_invitations/

List Customer Invitations

Returns a list of customer invitations for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Customer Invitations retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations().get();

POST/v5/vehicles/{uuid1}/customer_invitations/

Create Customer Invitation

Creates a new customer invitation and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`role`required	`string`	-max: 256
`customer_uuid`	`string (uuid)`	-
`first_name`	`string`nullable	-max: 256
`last_name`	`string`nullable	-max: 256
`email`	`string (email)`	-max: 256

Responses

200Customer Invitation created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "your_role"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "role": "your_role"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "role": "your_role"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations().post({
    "role": "your_role"
  });

GET/v5/vehicles/{uuid1}/customer_invitations/{uuid2}

Retrieve Customer Invitation

Returns the requested customer invitation identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Customer Invitation retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").get()

DELETE/v5/vehicles/{uuid1}/customer_invitations/{uuid2}

Delete Customer Invitation

Deletes the requested customer invitation identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Customer Invitation deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").delete()

GET/v5/vehicles/{uuid1}/customer_invitations/{uuid2}/accept/

List Accept

Returns a list of accept for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`jwt`required	`string`	JSON Web Token

Responses

200Accept retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/accept/?jwt=your_jwt" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/accept/?jwt=your_jwt", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/accept/?jwt=your_jwt",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").accept().get({
    "jwt": "your_jwt"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").accept().get([
    "jwt": "your_jwt"
])

val api = fleetFlow.customer(version = "v5")

val response = api.get("vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/accept", mapOf(
    "jwt" to "your_jwt"
))

GET/v5/vehicles/{uuid1}/customer_invitations/{uuid2}/decline/

List Decline

Returns a list of decline for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`jwt`required	`string`	JSON Web Token

Responses

200Decline retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/decline/?jwt=your_jwt" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/decline/?jwt=your_jwt", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/decline/?jwt=your_jwt",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").decline().get({
    "jwt": "your_jwt"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customer_invitations()("550e8400-e29b-41d4-a716-446655440000").decline().get([
    "jwt": "your_jwt"
])

val api = fleetFlow.customer(version = "v5")

val response = api.get("vehicles/550e8400-e29b-41d4-a716-446655440000/customer_invitations/550e8400-e29b-41d4-a716-446655440000/decline", mapOf(
    "jwt" to "your_jwt"
))

GET/v5/vehicles/{uuid1}/customers/

List Customers

Returns a list of customers for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Customers retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customers().get();

POST/v5/vehicles/{uuid1}/customers/

Create Customer

Creates a new customer and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Customer created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customers().post();

GET/v5/vehicles/{uuid1}/customers/{uuid2}

Retrieve Customer

Returns the requested customer identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Customer retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customers()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}/customers/{uuid2}

Update Customer

Updates the requested customer identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Customer updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customers()("550e8400-e29b-41d4-a716-446655440000").patch();

DELETE/v5/vehicles/{uuid1}/customers/{uuid2}

Delete Customer

Deletes the requested customer identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Customer deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/customers/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").customers()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/vehicles/{uuid1}/fault_codes/

List Fault Codes

Returns a list of fault codes for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Fault Codes retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").fault_codes().get();

POST/v5/vehicles/{uuid1}/fault_codes/

Create Fault Code

Creates a new fault code and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`type`required	`string`	-max: 256
`code`required	`string`	-max: 256
`description`	`string`nullable	-max: 256
`status`	`string`	-max: 256

Responses

200Fault Code created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "your_type",
    "code": "your_code"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "type": "your_type",
      "code": "your_code"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "type": "your_type",
        "code": "your_code"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").fault_codes().post({
    "type": "your_type",
    "code": "your_code"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").fault_codes().post([
    "type": "your_type",
    "code": "your_code"
])

GET/v5/vehicles/{uuid1}/fault_codes/{uuid2}

Retrieve Fault Code

Returns the requested fault code identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Fault Code retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").fault_codes()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}/fault_codes/{uuid2}

Update Fault Code

Updates the requested fault code identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`	`string`	-max: 256

Responses

200Fault Code updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").fault_codes()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").fault_codes()("550e8400-e29b-41d4-a716-446655440000").patch([
    "status": "your_status"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/fault_codes/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "status" to "your_status"
))

GET/v5/vehicles/{uuid1}/iot_command_queue/

List IoT Command Queue

Returns a list of iot command queue for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200IoT Command Queue retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").iot_command_queue().get();

GET/v5/vehicles/{uuid1}/iot_command_queue/{uuid2}

Retrieve IoT Command Queue

Returns the requested iot command queue identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200IoT Command Queue retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").iot_command_queue()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").iot_command_queue()("550e8400-e29b-41d4-a716-446655440000").get()

PATCH/v5/vehicles/{uuid1}/iot_command_queue/{uuid2}

Update IoT Command Queue

Updates the requested iot command queue identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`required	`string`	-max: 256

Responses

200IoT Command Queue updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").iot_command_queue()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").iot_command_queue()("550e8400-e29b-41d4-a716-446655440000").patch([
    "status": "your_status"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/iot_command_queue/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "status" to "your_status"
))

GET/v5/vehicles/{uuid1}/maintenance_history/

List Maintenance History

Returns a list of maintenance history for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Maintenance History retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history().get();

POST/v5/vehicles/{uuid1}/maintenance_history/

Create Maintenance History

Creates a new maintenance history and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`completed_at`	`string (date-time)`	-

Responses

200Maintenance History created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "completed_at": "2024-01-15T10:30:00Z"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "completed_at": "2024-01-15T10:30:00Z"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "completed_at": "2024-01-15T10:30:00Z"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history().post({
    "completed_at": "2024-01-15T10:30:00Z"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history().post([
    "completed_at": "2024-01-15T10:30:00Z"
])

GET/v5/vehicles/{uuid1}/maintenance_history/{uuid2}

Retrieve Maintenance History

Returns the requested maintenance history identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Maintenance History retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history()("550e8400-e29b-41d4-a716-446655440000").get()

PATCH/v5/vehicles/{uuid1}/maintenance_history/{uuid2}

Update Maintenance History

Updates the requested maintenance history identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Maintenance History updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history()("550e8400-e29b-41d4-a716-446655440000").patch();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history()("550e8400-e29b-41d4-a716-446655440000").patch()

DELETE/v5/vehicles/{uuid1}/maintenance_history/{uuid2}

Delete Maintenance History

Deletes the requested maintenance history identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Maintenance History deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/maintenance_history/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").maintenance_history()("550e8400-e29b-41d4-a716-446655440000").delete()

GET/v5/vehicles/{uuid1}/metadata/

List Metadata

Returns a list of metadata for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Metadata retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").metadata().get();

GET/v5/vehicles/{uuid1}/metadata/{uuid2}

Retrieve Metadata

Returns the requested metadata identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Metadata retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}/metadata/{uuid2}

Update Metadata

Updates the requested metadata identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`value`required	`string`nullable	-

Responses

200Metadata updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "your_value"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "value": "your_value"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "value": "your_value"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").patch({
    "value": "your_value"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").patch([
    "value": "your_value"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "value" to "your_value"
))

DELETE/v5/vehicles/{uuid1}/metadata/{uuid2}

Delete Metadata

Deletes the requested metadata identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Metadata deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/metadata/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").metadata()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/vehicles/{uuid1}/ownership_requests/

List Ownership Requests

Returns a list of ownership requests for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`page`	`integer`	-
`query`	`string`	-
`match`	`object`	-
`no_limit`	`boolean`	-

Responses

200Ownership Requests retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests().get();

GET/v5/vehicles/{uuid1}/ownership_requests/{uuid2}

Retrieve Ownership Request

Returns the requested ownership request identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`query`	`string`	-
`match`	`object`	-

Responses

200Ownership Request retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").get();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").get()

PATCH/v5/vehicles/{uuid1}/ownership_requests/{uuid2}

Update Ownership Request

Updates the requested ownership request identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`status`	`string`nullable	-max: 256

Responses

200Ownership Request updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "your_status"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "status": "your_status"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "status": "your_status"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").patch({
    "status": "your_status"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").patch([
    "status": "your_status"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "status" to "your_status"
))

DELETE/v5/vehicles/{uuid1}/ownership_requests/{uuid2}

Delete Ownership Request

Deletes the requested ownership request identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Ownership Request deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").delete();

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").delete()

GET/v5/vehicles/{uuid1}/ownership_requests/{uuid2}/accept/

List Accept

Returns a list of accept for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`jwt`required	`string`	JSON Web Token

Responses

200Accept retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/accept/?jwt=your_jwt" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/accept/?jwt=your_jwt", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/accept/?jwt=your_jwt",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").accept().get({
    "jwt": "your_jwt"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").accept().get([
    "jwt": "your_jwt"
])

val api = fleetFlow.customer(version = "v5")

val response = api.get("vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/accept", mapOf(
    "jwt" to "your_jwt"
))

GET/v5/vehicles/{uuid1}/ownership_requests/{uuid2}/decline/

List Decline

Returns a list of decline for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`jwt`required	`string`	JSON Web Token

Responses

200Decline retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/decline/?jwt=your_jwt" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/decline/?jwt=your_jwt", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/decline/?jwt=your_jwt",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").decline().get({
    "jwt": "your_jwt"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").ownership_requests()("550e8400-e29b-41d4-a716-446655440000").decline().get([
    "jwt": "your_jwt"
])

val api = fleetFlow.customer(version = "v5")

val response = api.get("vehicles/550e8400-e29b-41d4-a716-446655440000/ownership_requests/550e8400-e29b-41d4-a716-446655440000/decline", mapOf(
    "jwt" to "your_jwt"
))

GET/v5/vehicles/{uuid1}/rides/

List Rides

Returns a list of rides for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Rides retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").rides().get();

POST/v5/vehicles/{uuid1}/rides/

Create Ride

Creates a new ride and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Ride created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").rides().post();

GET/v5/vehicles/{uuid1}/rides/{uuid2}

Retrieve Ride

Returns the requested ride identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Ride retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").rides()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}/rides/{uuid2}

Update Ride

Updates the requested ride identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Ride updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").rides()("550e8400-e29b-41d4-a716-446655440000").patch();

DELETE/v5/vehicles/{uuid1}/rides/{uuid2}

Delete Ride

Deletes the requested ride identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Ride deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").rides()("550e8400-e29b-41d4-a716-446655440000").delete();

GET/v5/vehicles/{uuid1}/rides/statistics/

List Statistics

Returns a list of statistics for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Query Parameters

Name	Type	Description
`from_timestamp`	`string (date-time)`	-
`to_timestamp`	`string (date-time)`	-

Responses

200Statistics retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/statistics/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/statistics/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/rides/statistics/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").rides().statistics().get();

POST/v5/vehicles/{uuid1}/timestream/

Create Timestream

Creates a new timestream and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`name`required	`string`	-max: 256
`data`	`string`nullable	-

Responses

200Timestream created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/timestream/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "your_name"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/timestream/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "name": "your_name"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/timestream/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "name": "your_name"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").timestream().post({
    "name": "your_name"
  });

GET/v5/vehicles/{uuid1}/track/

List Track

Returns a list of track for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Responses

200Track retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").track().get();

POST/v5/vehicles/{uuid1}/track/

Create Track

Creates a new track and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`expires_at`	`string (date-time)`	-

Responses

200Track created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expires_at": "2024-01-15T10:30:00Z"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "expires_at": "2024-01-15T10:30:00Z"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "expires_at": "2024-01-15T10:30:00Z"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").track().post({
    "expires_at": "2024-01-15T10:30:00Z"
  });

GET/v5/vehicles/{uuid1}/track/{uuid2}

Retrieve Track

Returns the requested track identified by the path UUID parameter(s).

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Track retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").track()("550e8400-e29b-41d4-a716-446655440000").get();

PATCH/v5/vehicles/{uuid1}/track/{uuid2}

Update Track

Updates the requested track identified by the path UUID parameter(s) and returns the updated record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Request Body

Name	Type	Description
`expires_at`	`string (date-time)`	-

Responses

200Track updated successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X PATCH "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "expires_at": "2024-01-15T10:30:00Z"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "expires_at": "2024-01-15T10:30:00Z"
  })
});

const data = await response.json();

import requests

response = requests.patch(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "expires_at": "2024-01-15T10:30:00Z"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").track()("550e8400-e29b-41d4-a716-446655440000").patch({
    "expires_at": "2024-01-15T10:30:00Z"
  });

let fleetFlow = FleetFlow.shared

let response = try await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").track()("550e8400-e29b-41d4-a716-446655440000").patch([
    "expires_at": "2024-01-15T10:30:00Z"
])

val api = fleetFlow.customer(version = "v5")

val response = api.patch("vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000", mapOf(
    "expires_at" to "2024-01-15T10:30:00Z"
))

DELETE/v5/vehicles/{uuid1}/track/{uuid2}

Delete Track

Deletes the requested track identified by the path UUID parameter(s) and returns a confirmation payload.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-
`uuid2`required	`string (uuid)`	-

Responses

200Track deleted successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X DELETE "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.delete(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/track/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").track()("550e8400-e29b-41d4-a716-446655440000").delete();

POST/v5/vehicles/{uuid1}/warranty_violations/

Create Warranty Violation

Creates a new warranty violation and returns the created record.

Path Parameters

Name	Type	Description
`uuid1`required	`string (uuid)`	-

Request Body

Name	Type	Description
`key`required	`string`	-max: 256
`title`	`string`	-max: 256
`description`	`string`nullable	-max: 256

Responses

200Warranty Violation created successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X POST "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/warranty_violations/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "your_key"
  }'

const response = await fetch("https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/warranty_violations/", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      "key": "your_key"
  })
});

const data = await response.json();

import requests

response = requests.post(
    "https://customer-api.fleetflow.io/v5/vehicles/550e8400-e29b-41d4-a716-446655440000/warranty_violations/",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
        "key": "your_key"
}
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").vehicles()("550e8400-e29b-41d4-a716-446655440000").warranty_violations().post({
    "key": "your_key"
  });

Weather

Operations related to weather

2 endpoints

GET/v5/weather/current/

List Current

Returns a list of current for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`latitude`required	`number (float)`	-
`longitude`required	`number (float)`	-

Responses

200Current retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/weather/current/?latitude=10.5&longitude=10.5" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/weather/current/?latitude=10.5&longitude=10.5", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/weather/current/?latitude=10.5&longitude=10.5",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").weather().current().get({
    "latitude": 10.5,
    "longitude": 10.5
  });

GET/v5/weather/forecast/

List Forecast

Returns a list of forecast for the authenticated organization. Use query parameters to filter, search, and paginate the result set.

Query Parameters

Name	Type	Description
`latitude`required	`number (float)`	-
`longitude`required	`number (float)`	-

Responses

200Forecast retrieved successfully

400Bad request. The request payload, query, or path parameters were invalid.

401Unauthorized. Missing or invalid OAuth token and/or API key.

Request

curl -X GET "https://customer-api.fleetflow.io/v5/weather/forecast/?latitude=10.5&longitude=10.5" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://customer-api.fleetflow.io/v5/weather/forecast/?latitude=10.5&longitude=10.5", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

const data = await response.json();

import requests

response = requests.get(
    "https://customer-api.fleetflow.io/v5/weather/forecast/?latitude=10.5&longitude=10.5",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    }
)

data = response.json()

import FleetFlowSDK from "@repo/js-sdk";

const fleetFlow = new FleetFlowSDK("fleetflow.io", {
  "X-Api-Key": "YOUR_API_KEY"
});
fleetFlow.setToken("YOUR_TOKEN");

const data = await fleetFlow.customer("v5").weather().forecast().get({
    "latitude": 10.5,
    "longitude": 10.5
  });

Need help? Contact us at support@fleetflow.io