{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7caa7f0d-e913-4130-9369-c55eadac7add","name":"Fleetpins | Hybrid IT Services","description":"## Getting Started\n\nThis page will help you get started with our API!\n\nWelcome to the Fleetpins v3 API documentation!\n\nThe v3 APIs are an evolution from the v1 and v2 versions that allow for a wide range of access to data and building seamless workflows for integrations. Using the v3 APIs, it is now possible to perform CRUD operations (including batch updates) with all entities in Fleetpins and also extract telematics data (vehicle location, vehicle health, driver behavior) in a way that is easier to ingest and process. This version of the APIs also supports webhook capabilities to subscribe to real-time events.\n\nAt a high level, the capabilities available as part of the v3 API are mentioned below:\n\n- CRUD operations on vehicles, users, groups, roles, device configurations, geofences, landmarks, alerts, and maintenance schedules\n    \n- Reporting information on live locations, breadcrumbs, trips (raw/summary), stops, events, state mileage, and dashcam videos\n    \n- Supports single and multiple updates in the same request\n    \n- Ability to sort, filter, limit, and search while making a request\n    \n\n### 🚧 Custom APIs & GraphQL\n\nWe also support creating customized endpoints that may prove to be beneficial if the standard APIs don't have the data you're looking for or involve making multiple requests to obtain the desired datasets. The custom APIs would be tailored specifically for your organization.\n\nWe're also exploring solutions to allow developers to query for data via GraphQL endpoints. Reach out to [<b>integration@fleetpins.com</b>](https://mailto:integration@fleetpins.com) in case you're interested in custom APIs or GraphQL.\n\nIf you notice the docs are out of date or are unclear, please don't hesitate to drop a note to [<b>integration@fleetpins.com</b>](https://mailto:integration@fleetpins.com)! We're working to keep these docs up to date, however, sometimes we get behind – and we'd love your help.\n\n## Units and Metrics\n\nThe Fleetpins API returns parameters, each having a different metric unit. The following table lists the metric units associated with different parameters.\n\nThese metrics are common across the Fleetpins API unless mentioned otherwise.\n\n| Parameter | Unit |\n| --- | --- |\n| Distance | Meters, Kilometers |\n| Currency | Dollars |\n| Fuel | Litres |\n| Speed | Kilometers per Hour |\n\n## Status Codes\n\nThe following codes are valid:\n\n| Code | Name | Reason |\n| --- | --- | --- |\n| 200 | Success | Everything worked successfully! |\n| 400 | Bad Request | Your request could not be understood by the server. |\n| 401 | Unauthorized | We couldn't authorize you, or you have used the wrong API key. |\n| 403 | Forbidden | The resource requested is restricted for your API Key. |\n| 404 | Not Found | The specified resource could not be found. |\n| 405 | Method Not Allowed | You tried to access a resource with an invalid method. |\n| 429 | Too many requests | You’re requesting too much! Slow down! |\n| 500 | Internal Server Error | Hell's fire let loose. |\n| 503 | Service Unavailable | We’re temporarily offline for maintenance. Please try again later. |\n\n❗️ **Watch Out!**\n\nWe may return errors not listed above, so don't rely on the errors. Check the content of the JSON blob as well.\n\nAll errors will return a JSON blob in the following format:\n\n``` json\n{\n  \"code\": 403,\n  \"message\": \"Your API Key does not have the privilege to access this set of information\"\n}\n\n ```\n\n## Authentication Workflow\n\nThe v3 endpoints support authentication using JWT tokens that are generated by making a request to our authentication API using the user's credentials. Once the token is obtained, it needs to be added to the header of every request by prefixing the word \"Bearer\" before the token.\n\nHere's a simple request to get all vehicles in the account. Notice the use of the bearer token in the request header.\n\n### cURL Example\n\n``` bash\ncurl -L -X POST 'https://services.fleetpins.com/fleetpins-ws-oauth/v3/trackees?lastSyncTime=0' \\\n-H 'Authorization: Bearer w2jSAxPG8IeaKJMcFaEGxTB1tj5XS9Q2y' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{}'\n\n ```\n\nSince the token is generated for a user account, the user's permissions/roles will apply to API operations as well. For example, a user that does not have access to create geofences will not be able to create geofences using the APIs as well.\n\nEndFragment","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24944789","team":4329630,"collectionId":"7caa7f0d-e913-4130-9369-c55eadac7add","publishedId":"2sAYdmn8S8","public":true,"publicUrl":"https://developer.fleetpins.com","privateUrl":"https://go.postman.co/documentation/24944789-7caa7f0d-e913-4130-9369-c55eadac7add","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0C71D0"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Welcome to the Fleetpins v3 API documentation!"},{"name":"title","value":"FleetPins APIs"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/44fdd21e-208d-4fe1-b09e-4578200cf0bd/bG9nby1mb290ZXJfMngucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0C71D0"}},{"name":"light","logo":"https://content.pstmn.io/14875c06-1876-45dc-bc8b-b54ab34422df/bG9nb18yeC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0C71D0"}}]}},"version":"8.10.1","publishDate":"2025-03-07T22:41:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"FleetPins APIs","description":"Welcome to the Fleetpins v3 API documentation!"},"logos":{"logoLight":"https://content.pstmn.io/14875c06-1876-45dc-bc8b-b54ab34422df/bG9nb18yeC5wbmc=","logoDark":"https://content.pstmn.io/44fdd21e-208d-4fe1-b09e-4578200cf0bd/bG9nby1mb290ZXJfMngucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/5c643e798fc7f9c302d28ddea99b1c11d767a16b2322756b9ae17de70f36a244","favicon":"https://fleetpins.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developer.fleetpins.com/view/metadata/2sAYdmn8S8"}