{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"95cbb6cf-b825-4924-922c-6a452fc17096","name":"Carpool Customer API","description":"Welcome! We're glad you're here to integrate with the Carpool Customer API.\n\n# Getting Started\n\nThis guide will help you set up your API access smoothly and efficiently. Let’s get you up and running.\n\n### Step 1: Secure Your Credentials\n\nTo access our API, you’ll need a username and password. If you haven't received these yet, please reach out to our support team at [tms@carpoollogisitics.com](https://mailto:tms@carpoollogisitics.com). We’ll provide you with the necessary credentials promptly.\n\n### Step 2: Authenticate with an API Key\n\nFor security purposes, we use API Keys. Here’s a quick walkthrough to create yours:\n\n**1\\. Log In to Carpool TMS**\n\nSign in at [https://my.carpoollogistics.com/](https://my.carpoollogistics.com/) with your provided credentials.\n\n\n\n**2\\. Navigate to API Keys**\n\nClick on the user profile icon in the top right corner and select \"API Keys\" from the dropdown menu.\n\n\n\n**3\\. Generate Your Key**\n\nEnter a descriptive name for your key, click \"Create\", and make sure to copy and securely store your key.\n\n\n\n\n\n# Accept Header\n\nThe Carpool Customer API requires that the Accept header be set to `application/json` for all requests. This header indicates that the client expects JSON responses from the API.\n\n### Importance of the Accept Header\n\nSetting the Accept header to `application/json` is crucial for ensuring that the API responses are in JSON format, facilitating easy management and parsing on the client side.\n\n### Example of Setting the Accept Header\n\nWhen making requests, include the Accept header as follows:\n\n``` bash\ncurl -X GET \"https://my.carpoollogisitics.com/api/user/me\" \\\n -H \"Accept: application/json\"\n\n ```\n\nThis header should accompany all of your API requests.\n\n# Authorization\n\nSecure access to the Carpool Customer API requires that all requests be accompanied by a valid API Key and the appropriate Accept header. This section explains how to include your API Key and set the Accept header in your API requests to authorize your interactions with the API.\n\n### API Key Usage\n\nAfter obtaining your API Key, it must be included in the Authorization header of every API request. Additionally, to ensure responses are in the correct format, you must specify `application/json` as the value of the Accept header.\n\n#### Adding the API Key and Accept Header to Your Requests\n\nTo authenticate your requests, add the API Key as Bearer to the Authorization header. Also, include the Accept header with the value `application/json` to specify that you expect the response in JSON format:\n\n``` shell\nAuthorization: Bearer YOUR_API_KEY_HERE\nAccept: application/json \n\n ```\n\nReplace `YOUR_API_KEY_HERE` with your actual API Key.\n\n### Handling Expired or Incorrect Keys\n\nIf your API Key is expired or incorrect, you will receive a 401 Unauthorized status code with the following response body:\n\n``` json\n{\n \"message\": \"Unauthenticated.\"\n}\n\n ```\n\n# Response Structure\n\nAll responses from the Carpool Customer API are wrapped in a `data` object. Here is an example of a typical response:\n\n``` json\n{\n \"data\": {\n \"id\": 1,\n \"first_name\": \"Sam\",\n \"last_name\": \"Smith\",\n \"phone\": \"+14045551212\",\n \"email\": \"sam@customer.com\",\n \"teams\": []\n }\n}\n\n ```\n\nThis standardized response format applies to all endpoints across the Carpool Customer API, making it straightforward for developers to parse and utilize the returned data.\n\n# Help\n\nIf you need any help or assistance, please reach out to our support team at [tms@carpoollogisitics.com](https://mailto:tms@carpoollogisitics.com).\n\n# Release Notes\n\nOrders & Customers API is currently under development. There may be additions response or request bodies. These APIs will be available for public consumption March 2025.\n\n---\n\n# Endpoints","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"5137531","team":3853683,"collectionId":"95cbb6cf-b825-4924-922c-6a452fc17096","publishedId":"2sA35G21WD","public":true,"publicUrl":"https://documentation.carpoollogistics.com","privateUrl":"https://go.postman.co/documentation/5137531-95cbb6cf-b825-4924-922c-6a452fc17096","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-12-03T16:51:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/52a0f837741b2f685af37b7309d93813406604287cbe6efbf32b3df2650448cc","favicon":"https://carpoollogistics.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://documentation.carpoollogistics.com/view/metadata/2sA35G21WD"}