{"_id":"5939cee54ea7ce000f36deb7","project":"56539c418b050e2100f006ca","version":{"_id":"56539c428b050e2100f006cd","project":"56539c418b050e2100f006ca","__v":12,"createdAt":"2015-11-23T23:07:46.327Z","releaseDate":"2015-11-23T23:07:46.327Z","categories":["56539c428b050e2100f006ce","5789af34f55bf80e00d0c34f","5789af4e6a16260e006e7cd4","5789af53d7bf751900e3cbe1","5789af576a16260e006e7cd5","5789af5fc1c3de0e00169dc7","5789af64c1c3de0e00169dc8","5789b0067a572c0e00120269","579919b1b8d3432000fdffc3","590ba9d1030acd0f00f07046","5939cecbc78839000f4bff0e","59c4454a414f98001001f2a9"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5939cecbc78839000f4bff0e","project":"56539c418b050e2100f006ca","version":"56539c428b050e2100f006cd","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-08T22:25:15.356Z","from_sync":false,"order":8,"slug":"api","title":"API"},"user":"55ef2835e7f5490d000c0e4f","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-08T22:25:41.422Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The API allows extraction of task allocation and staff data in a machine-readable way. \n[block:api-header]\n{\n  \"title\": \"API Key\"\n}\n[/block]\nHere's how to generate an API key for your PlanRight organisation: \n1. Navigate to the Settings page\n2. Choose the API tab\n3. Click the Create New API Key button\n\nThe generated value should be used as the \"key\" value when making API requests. To disable the key, click the key and choose Disable API Key. \n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Disabling API Keys is permanent\",\n  \"body\": \"API Keys cannot be re-enabled once disabled, so be sure a key is no longer in use before disabling it.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/d47648d-c2035d8-Screen_Shot_2017-06-09_at_8.22.24_AM.png\",\n        \"c2035d8-Screen_Shot_2017-06-09_at_8.22.24_AM.png\",\n        641,\n        298,\n        \"#f3f4f4\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"API EndPoints\"\n}\n[/block]\nThe API includes the following endpoints:\n\n- [Staff](/docs/staff-api)\n- [Tasks](http://help.planrightapp.com/docs/tasks-1)\n- [iCal](http://help.planrightapp.com/docs/ical)","excerpt":"","slug":"api-overview","type":"basic","title":"API Overview"}
The API allows extraction of task allocation and staff data in a machine-readable way. [block:api-header] { "title": "API Key" } [/block] Here's how to generate an API key for your PlanRight organisation: 1. Navigate to the Settings page 2. Choose the API tab 3. Click the Create New API Key button The generated value should be used as the "key" value when making API requests. To disable the key, click the key and choose Disable API Key. [block:callout] { "type": "danger", "title": "Disabling API Keys is permanent", "body": "API Keys cannot be re-enabled once disabled, so be sure a key is no longer in use before disabling it." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/d47648d-c2035d8-Screen_Shot_2017-06-09_at_8.22.24_AM.png", "c2035d8-Screen_Shot_2017-06-09_at_8.22.24_AM.png", 641, 298, "#f3f4f4" ] } ] } [/block] [block:api-header] { "title": "API EndPoints" } [/block] The API includes the following endpoints: - [Staff](/docs/staff-api) - [Tasks](http://help.planrightapp.com/docs/tasks-1) - [iCal](http://help.planrightapp.com/docs/ical)