{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8b601bdd-d04d-418e-bd88-2620aa34d0f4","name":"Curvenote","description":"You can use this guide to get started with the Curvenote API.\n\n# Overview\n\n## Note ⚠️\n\nThis API is in developer preview, there may be backward-incompatible changes.\n\n## Authentication\n\nOnce you are signed up for an account, you can [generate an API Key](https://curvenote.com/profile?settings=true&tab=profile-api) in your settings.  \nYour API key is a [JSON Web Token](https://jwt.io/introduction/), it is equivalent to your username and password so **keep it in a safe place**.  \nFor an authenticated request, you will need to add this `{{token}}` in an `Authorization` header in the request:\n\n```\ncurl -H \"Authorization: YOUR_API_TOKEN\" -X POST https://api.curvenote.com/login\n\n```\n\nThis will return a session token in the body that you can use to interact with the rest of the API.\n\n```\ncurl -H \"Authorization: YOUR_SESSION_TOKEN\" https://api.curvenote.com/me\n\n```\n\nNote that some parts of the API will return a `404` not found instead of a `401` unauthorized to protect sensitive information.\n\n## Browsing the API\n\nThere are multiple places in the user interface in Curvenote that allow you to open blocks in the API, this will log you in using an `authorization` cookie. If you use a browser extension to render JSON (e.g. in [chrome](https://chrome.google.com/webstore/detail/json-viewer/gbmdgpbipfallnflgajpaliibnhdgobh), [firefox](https://addons.mozilla.org/en-CA/firefox/addon/jsonview/), etc.) then you can click on the hypermedia links to quickly get a feel for the data-structures in the API.\n\nThis cookie has the same form as the JWT token described above, however, it is only valid for 24 hours. As such, it should **not** be used for API calls made from a client library.\n\nYou can also browse this documentation with [Postman](postman.co), which allows you to set environment variables, post requests, and see responses. You will also get to start with this documentation as your base!\n\n## HTTP Verbs\n\n| HTTP Verb | Description |\n| --- | --- |\n| `GET` | Retrieve entities in the API. |\n| `POST` | Create new entities. |\n| `PATCH` | Partially update data for an object. |\n| `DELETE` | Delete an entity. |\n\n## Hypermedia\n\nAll objects returned by the API have a `links` object that provides links to relevant and related entities. These links are used to give explicit pointers based on long-lived URLs. Client libraries should follow these links to consume potential future changes to the API. All objects will have at least one link called `self` - this is a link to the entity at its canonical URL.\n\n## Pagination\n\nSome base URLs, for example, `https://api.curvenote.com/projects` will return multiple items. The data will be returned in an items list and you can control how many are returned by using the `limit` query parameter. By default, there are `50` items returned. If there are more items, then a `next` link will be available.\n\n```\n{\n  \"items\": [ ... ],\n  \"links\": {\n    \"self\": \"https://api.curvenote.com/endpoint\",\n    \"next\": \"https://api.curvenote.com/endpoint?limit={{ limit }}&snapshot={{ lastId }}\"\n  }\n}\n\n```\n\n## Conventions\n\nAll dates are returned in [ISO-8601 format](http://en.wikipedia.org/wiki/ISO_8601), which is of the form `YYYY-MM-DDTHH:mm:ss.sssZ`. The timezone is always set to zero UTC offset, as denoted by the suffix \"Z\".\n\nIn javascript, this is the same format as `new Date().toISOString()` and can be directly loaded into the `Date` function.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"4954379","collectionId":"8b601bdd-d04d-418e-bd88-2620aa34d0f4","publishedId":"Szzj9dXS","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4954379/Szzj9dXS","privateUrl":"https://go.postman.co/documentation/4954379-8b601bdd-d04d-418e-bd88-2620aa34d0f4","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"235f9d"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-08-23T23:23:39.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/b915f3c22d85bdbee33554a5d561e555dc859e20d7373af9b6d37fe0d327fc14","favicon":"https://res.cloudinary.com/postman/image/upload/v1629759532/team/d979sdzmaxxhjgpes1r4.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://documenter.gw.postman.com/view/metadata/Szzj9dXS"}