{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5dc57c39-97e6-476f-9029-25a7fb32c81b","name":"Kelloo API","description":"# Overview\n\nThis is a REST-style API that uses serialized JSON and OAuth2 authentication. The Kelloo API provides programmatic access to Kelloo via an HTTP-based JSON REST interface. The Kelloo API is a RESTful interface, providing programmatic access to much of the data in the system.\n\n# API Responses\n\n## HTTP response status\n\nThe http response status indicates at a high level the result of the API call.\n\nThe following http status values will be returned by the API\n\n> 200 Success\n\n> The request was entirely successful.\n\n> 400: Bad request\n\n> This is usually returned if you try to pass invalid parameters to an API.\n\n> 401: Unauthorized\n\n> This means that you have not passed a valid access_token in the Authorization header\n\n> 403: Forbidden\n\n> Means the action you have requested could not be done, i.e. an update with an invalid value or a delete that could not be processed to maintain data referential integrity.\n\n> 404: Not found\n\n> Means that the request could not be found.\n\n> 429: Too many requests\n\n> This means that the daily request limit of the API has been reached.\n\n## API Response data\n\nThe response data from the API has a content type of application/json. The JSON data set returned has 4 base entries as follows:\n\n| **Field** | **Type** | **Description** |\n| --- | --- | --- |\n| status | string | This will be 0 if the request was successful.  <br>If the Http Status is in the 4** range then this will reflect that error status. |\n| errorText | string | A text string denoting the high level error if the error status is in the 4** range. |\n| remainingRequests | integer | The number of API requests you have remaining before Midnight UTC. |\n| data | object | This is the object data requested. Details of the different objects returned will be found in the API Reference section of this document. |\n\n## API Response status values\n\nThe following statuses will decrement the remainingRequests value.\n\n> 0:\n\n> This status means that the API request has been processed successfully.\n\n> 400: Bad request\n\n> This is usually returned if you try to pass invalid parameters to an API.\n\n> 403: Forbidden\n\n> Means the action you have requested could not be done, i.e. an update with an invalid value or a delete that could not be processed to maintain data referential integrity.\n\n> 404: Not found\n\n> Means that a requested record could not be found.\n\nThe following statuses will not decrement the remainingRequests value.\n\n> 401: Unauthorized\n\n> This means that you have not passed a valid Authorization header and the API could not verify your identity.\n\n> 429: Too many requests\n\n> Means that you have exceeded your daily rate limit for the API. The counter resets at midnight UTC. Rate limits are explained below.\n\n#### Response status\n\nEach updatable record returned by the API in the data object will also have a status attached to give more detailed information.\n\nFor example if you receive a 403: Forbidden status then interrogate the data records to find out why the action failed. As an example, if you try to create a project and specify a name that already exists you will get the following project level API status:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| api_valid | boolean | If false then the record is in error. |\n| status_messages | Array of messages | If the record is in error then 1 or more messages will appear in this list. If there is no error this list is empty. |\n\n# **Rate limits**\n\nYou can perform 250 requests per day for a trial account and 2500 per day for a paid account.\n\n# **Getting help**\n\nIf you have any questions about the api, please contact [support@kelloo.com](mailto:support@kelloo.com).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14463756","team":3605392,"collectionId":"5dc57c39-97e6-476f-9029-25a7fb32c81b","publishedId":"UzBgtpF8","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14463756/UzBgtpF8","privateUrl":"https://go.postman.co/documentation/14463756-5dc57c39-97e6-476f-9029-25a7fb32c81b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-13T10:28:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"plan.kelloo.com","id":"34545819-13e4-4ca9-b9cf-4beef7613c70","owner":"14463756","values":[{"key":"oauth_uri","value":"https://plan.kelloo.com/OAuth2/token","enabled":true,"type":"default"},{"key":"api_uri","value":"https://plan.kelloo.com/api","enabled":true,"type":"default"},{"key":"client_id","value":"**your kelloo client id**","enabled":true,"type":"default"},{"key":"client_secret","value":"**your kelloo client secret**","enabled":true,"type":"default"},{"key":"refresh_token","value":"**your kelloo refresh token**","enabled":true,"type":"default"},{"key":"access_token","value":"**your kelloo oauth2 access token**","enabled":true,"type":"default"}],"published":true}],"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/9c26813060322b4836494fc04ab00cd7a0424dfc81e04003bcd963d7e41390a9","favicon":""},"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"},{"label":"plan.kelloo.com","value":"14463756-34545819-13e4-4ca9-b9cf-4beef7613c70"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UzBgtpF8"}