{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4caa5747-0fc7-444b-abbf-f07e11829669","name":"COMMITLY (API)","description":"The COMMITLY API uses [OAuth 2.0](https://oauth.net/2/) for authentication.\n\n## Base URL\n\n{{baseUrl}}\n\n## Client Application\n\nA client application needs to be identified by Client ID and Client Secret. You can retrieve the required Client ID and Client Secret by activating the COMMITLY API within your COMMITLY Account. Note: API Credentials can be created for Business Edition upwards.\n\nGo to your COMMITLY Account. In the main navigation select ADD-ONS > COMMITLY Direct API and click on connect. This will generate the client ID and client secret.\n\n## Authentication Flow\n\n<img src=\"https://lh6.googleusercontent.com/timbhKOuzsSDbOTgpdjnJrlnNhoB0ZIOis8YXB1Mnr6FPTHTLrpEHeUzl5EYZmRSQnDgXwHKypk1fPY6MN3mAmAIHUI4GLS4HN43u4ifB6YIUK9StGxHJ95Q_INB5VsWuQmifJDT\">\n\n1. The client’s app authenticates with COMMITLY backend using its Client ID and Client Secret (/auth/token/ endpoint). **Send client credentials in body.**\n    \n2. COMMITLY backend validates the Client ID and Client Secret.\n    \n3. COMMITLY backend responds with an Access Token.\n    \n4. The client’s application can use the Access Token to call an API on behalf of itself.\n    \n5. The API responds with the requested data.\n    \n\n## Access Token\n\nThe Access Token is used to authenticate against the API resources. It needs to be included in every request header with the prefix bearer.\n\n## Access Token Url\n\n{{baseUrl}}/auth/token/\n\n## Example Setup of Authorization in Postman\n\nIn our test setup, we have setup Authorization on COMMITLY (API) level.\n\n- Select OAuth 2.0 as Type\n    \n- Add auth data to: Request Headers\n    \n- Enable auto-refresh Token\n    \n\n<img src=\"https://content.pstmn.io/be6fd8b7-029e-4f7d-ba3f-84aa1bcf3c0b/QmlsZHNjaGlybcKtZm90byAyMDI0LTAxLTE3IHVtIDA5LjE0LjUyLnBuZw==\">\n\nTo configure the New Token\n\n- Set Access Token URL to /auth/token/\n    \n- Insert Client ID and Client Secret\n    \n- Client Authentication: Send client credentials in body\n    \n\n**Important: for security reason (and out of convenience) define variables in an Environment. Select the variable type SECRET for Client ID and Client Secret.**\n\n<img src=\"https://content.pstmn.io/c1fee5df-14af-4e3b-a04c-ed827ca94044/QmlsZHNjaGlybcKtZm90byAyMDI0LTAxLTE3IHVtIDA5LjE1LjI1LnBuZw==\">\n\non Entity Level, select Authorization Type to **Inherit auth from parent**\n\n<img src=\"https://content.pstmn.io/94285d94-8bf2-4ec3-96ab-cee20df6d7a0/QmlsZHNjaGlybcKtZm90byAyMDI0LTAxLTE3IHVtIDA5LjIxLjExLnBuZw==\">\n\nTo start making calls, initiate Authorization first on parent level by clicking on Get New Access Token\n\n<img src=\"https://content.pstmn.io/c5891e7a-2dbb-4775-b654-fd4c94cfcee7/QmlsZHNjaGlybcKtZm90byAyMDI0LTAxLTE3IHVtIDA5LjI1LjAzLnBuZw==\">\n\nSuccessful authentication will be displayed. Click on Proceed.\n\n<img src=\"https://content.pstmn.io/71b8b372-7b65-48fc-b189-60913592d4b1/QmlsZHNjaGlybcKtZm90byAyMDI0LTAxLTE3IHVtIDA5LjI1LjI0LnBuZw==\">\n\nCOMMITLY backend sent in this case an access token. Click on Use Token.\n\n<img src=\"https://content.pstmn.io/66302894-c50f-49e1-8bb4-175c2227ed66/QmlsZHNjaGlybcKtZm90byAyMDI0LTAxLTE3IHVtIDA5LjM1LjQwLnBuZw==\">\n\nAfter that, you can now make API calls.\n\nIf you want to call different companies and/or groups, simply setup an Environment for every company / group with the provided client credentials.\n\n## Pagination & **Page size (limit)**\n\nPagination is the process of dividing the resulting set of data into discrete blocks of information (pages). It decreases both the server payload and the network traffic and increases the speed of page loading.\n\nThe number of returned records in `GET` requests is restricted to avoid server and network overloading. COMMITLY API responses limits the number of records to 100.\n\n## **Errors and HTTP status codes**\n\n- 200 - OK\n    \n- 400 - Bad request\n    \n- 401 - Not authenticated or invalid access_token\n    \n- 403 - Incorrect authorization role or you are not allowed to call this service for other reasons\n    \n- 404 - Not found\n    \n- 500 - An unexpected error occurred","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7203120","team":1001985,"collectionId":"4caa5747-0fc7-444b-abbf-f07e11829669","publishedId":"UVysyvwe","public":true,"publicUrl":"https://developer.commitly.com","privateUrl":"https://go.postman.co/documentation/7203120-4caa5747-0fc7-444b-abbf-f07e11829669","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"82C800"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-04-21T14:48:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/ea341d7e340242bcb294b5adc9b3a433266e75bd7ee7ddd9f310691af2f4d3e0","favicon":"https://res.cloudinary.com/postman/image/upload/v1588746744/team/sddcvgwi2pujzs0ktgq0.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.commitly.com/view/metadata/UVysyvwe"}