{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0c2d6389-cc6e-4337-9354-16e942203047","name":"API Documentation","description":"<img src=\"https://d2fl3xywvvllvq.cloudfront.net/wp-content/uploads/2021/11/nutcache_180.jpg\" alt=\"alt text\">\n\nWelcome to The Nutcache API! Use this API to easily interact with your Nutcache account programmatically. This guide offers a comprehensive suite of developer resources and web services to connect Nutcache to your existing tools and workflow.\n\n# Overview\n\nTo use the Nutcache API, an owner must first generate a public key. This action can be done directly in Nutcache under the \"My account -> Profile\" menu. From the \"Profile\" dialog, select the \"Manage API key\" link and click the \"+ API KEY\" to continue.\n\n<img src=\"https://d2fl3xywvvllvq.cloudfront.net/wp-content/uploads/2021/11/api_nutcache.jpg\" alt=\"alt text\">\n\n# Authentication\n\nAuthentication info must be provided along with your request within the Authorization header.\n\nAuthorization: Bearer access_token\n\n# Company context\n\nA company context is required when making requests. To do this, simply include the company GUID, which can be retrieved via the Company API from the request header.\n\n# Schema\n\nBlank Fields:\n\n- Blank fields are made null instead of being omitted.\n    \n\nTimestamps:\n\n- All timestamps are returned in the UTC format, YYYY-MM-DDTHH:MM:SSZ.\n    \n- For example, 2016-02-13T23:27:49Z\n    \n\nDate Fields:  \nInput for date fields is expected to be in one of the following formats:\n\n- YYYY-MM-DD\n    \n- YYYY-MM-DDTHH:MM\n    \n- YYYY-MM-DDTHH:MMZ\n    \n- YYYY-MM-DDTHH:MM:SS\n    \n- YYYY-MM-DDTHH:MM:SSZ\n    \n- YYYY-MM-DDTHH:MM:SS±hh:mm\n    \n- YYYY-MM-DDTHH:MM:SS±hh\n    \n- YYYY-MM-DDTHH:MM:SS±hhmm\n    \n\nIf the time zone information is not present, it will be assumed to be in UTC.\n\n- A few valid date fields - 2016-02-15T21:16:25Z , 2012-12-24T12:56:15+05:30, 2010-03-23T12:00\n    \n\n# Pagination\n\nAPI responses that return a list of objects, such as Projects, Customers or Time Entries are paginated. To scroll through the pages, add the parameter page to the query string. The page number starts with 1. By default, the number of objects returned per page is 10 and is limited to 100.\n\n# Rate limit\n\nA rate limit of 20 000 API calls per API key is allowed.  \nIf you go over this limit, Nutcache will start returning a HTTP 429 Too Many Requests error, and a Retry-After HTTP header containing the number of seconds until you can retry.\n\nHTTP/1.1 429 Too Many Requests Retry-After: 30\n\nThere is also a burst limit of 5 API calls per second and 200 per minute.\n\n# Errors\n\nAPI requests that result in errors will return an appropriate HTTP code to help you identify the type of error and fix it. You can use the table below to understand what each code means.\n\n| Code | Text | Description |\n| --- | --- | --- |\n| 400 | Client or Validation Error | This indicates that the request is not in the correct format. |\n| 401 | Access Denied | This indicates that the Authorization header is either missing or incorrect. |\n| 403 | Client or Validation Error | This indicates that the user whose credentials were used in making this request was not authorized to perform this API call. |\n| 404 | Requested Resource not Found | This code is returned when the request contains invalid ID/Nutcache domain in the URL or an invalid URL itself. For example, an API call to retrieve a project with an invalid ID will return a HTTP 404 status code to let you know that no such project exists. |\n| 429 | Too Many Requests | This code appears when the user has exceeded the API rate limit. In Nutcache, this limit is set to 20000 API requests per day per API key. |\n| 500 | Unexpected Server Error | This indicates an error on Nutcache's side. Please email us at [support@nutcache.com](https://mailto:support@nutcache.com) with any relevant information. We will reach out to you and fix this ASAP. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14635689","team":6343281,"collectionId":"0c2d6389-cc6e-4337-9354-16e942203047","publishedId":"Tz5i9g65","public":true,"publicUrl":"https://documenter-api.postman.tech/view/14635689/Tz5i9g65","privateUrl":"https://go.postman.co/documentation/14635689-0c2d6389-cc6e-4337-9354-16e942203047","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"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":"EF5B25"}}]}},"version":"8.11.6","publishDate":"2023-12-13T15:37:03.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Documentation","id":"2ba5bdc1-eaad-4782-926a-4dcf85bf8e35","owner":"14635689","values":[{"key":"server","value":"https://apps.nutcache.com/webapi","enabled":true},{"key":"api_version","value":"4","enabled":true},{"key":"company_guid","value":"11A5A746-6A92-42C6-B590-618250B5BACB","enabled":true},{"key":"username","value":"postmanDoc@yopmail.com","enabled":true},{"key":"password","value":"YourPassword1","enabled":true},{"key":"api_key","value":"FkqMg8cCTOAcFfZ8BGahYGacQTcx4oK69Uuq05cf","enabled":true},{"key":"access_token","value":"","enabled":true,"type":"any"},{"key":"company_id","value":"","enabled":true,"type":"any"},{"key":"access_token_for_rates","value":"","enabled":true,"type":"any"}],"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/0a0bf286f20ebd312c98ceea48129460523d55d1f80dc691ed1d69f14bdfd916","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":"Documentation","value":"14635689-2ba5bdc1-eaad-4782-926a-4dcf85bf8e35"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Tz5i9g65"}