CoderPad provides a simple API for programmatically creating and managing interview pads. You can use the API to integrate these pads with your internal interview scheduling platform or to get a text dump of an interview after the fact.
\nCoderPad provides a standard REST API that returns results in JSON format.
\nThe API uses a simple HTTP Authorization header to authenticate you. If you visit your settings page, you’ll see your API key (this one is fake):
8af9a3412559d803707937250dc1569d
\nYou can then make requests against the API endpoint like so:
\ncurl -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/pads\n\nThe authorization type for Interview is Bearer token:
The API will always return a top-level JSON object, along with a status code to indicate success or failure. When successful, the API will return an HTTP 200, as well as { status: \"OK\" }.
When calls are unsuccessful, they return an appropriate HTTP code, as well as something like
\n{\n \"status\": \"ERROR\",\n \"message\": \"Invalid API key\"\n}\n\nThe following is a table of HTTP codes from errors that you can expect to see:
\nWhen a resource contains a language field, it’s value is one of a set list:
angular
\nbash
\nc
\nclojure
\ncoffeescript
\ncpp
\ncsharp
\ndjango
\nelixir
\nerlang
\nfsharp
\ngin
\nhaskell
\nhtml
\njava
\njavascript
\njulia
\nkotlin
\nlua
\nmarkdown
\nnode
\nobjc
\nocaml
\nperl
\nphp
\nplaintext
\npostgresql
\npython
\nrails
\nreact
\nruby
\nrust
\nspring
\nsvelte
\nswift
\ntcl
\ntypescript
\nvb
\nvue
\nFetch a list of all of your pads. Returns everything that an individual Get pads by id request does. The only caveat is that the values of fields in the index view are not guaranteed to be 100% real-time. Generally, they should be no more than a minute behind, but if you absolutely require the latest value in a pad, please use the individual Get pads by id endpoint.
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n <a class='preserveHtml' class='preserveHtml' target=\"_blank\" rel=\"noreferrer noopener\" href=\"https://app.coderpad.io/api/pads?sort=updated_at,descThis\">https://app.coderpad.io/api/pads?sort=updated_at,desc</a>\n\nThis API endpoint takes an optional sort parameter, which allows you to sort by either the created_at or updated_at fields on your pads. Adding a comma will allow you to change the sort direction, which is desc by default. For example, to sort your pads by updated_at from oldest to newest, specify updated_at,asc.
If no sort parameter is provided, created_at,desc is assumed.
The method also returns paginated results - no more than 50 per request. If you want more, follow the next_page or prev_page urls if present. The API also returns a total count to give you a sense of how many pads you have created.
{\n \"status\": \"OK\",\n \"pads\": [\n // ... your pads, with the same data format as in `show`\n ],\n \"next_page\": \"https://app.coderpad.io/api/pads?sort=updated_at,desc&page=2\",\n \"total\": 420\n}\n\nReturns detail about a particular pad. Doing a straightforward curl like so:
\ncurl \\\n -H 'Authorization: Token token=\"c\"' \\\n https://app.coderpad.io/api/pads/DM32JWG2\n\nyields:
\n{\n status: \"OK\",\n id: \"DM32JWG2\",\n title: \"Ruby Test\",\n owner_email: \"fbueller@gmail.com\",\n language: \"ruby\",\n participants: [\n \"vincent\",\n \"Guest 405\"\n ],\n contents: \"5.times do\\n puts 'Hello, World!'\\nend\\n\",\n notes: \"Greg was a *very* gregarious candidate, whom...\"\n events: \"https://app.coderpad.io/api/pads/DM32JWG2/events\",\n private: false,\n execution_enabled: true,\n created_at: \"2014-11-14T03:02:45Z\",\n updated_at: \"2014-11-14T03:06:39Z\",\n ended_at: \"2014-11-14T03:06:39Z\",\n url: \"https://coderpad.io/DM32JWG2\",\n playback: \"https://coderpad.io/DM32JWG2/playback\",\n drawing: \"https://storage.googleapis.com/...\",\n pad_environment_ids: [\n 1234567,\n 7654321\n ],\n active_environment_id: 1234567,\n team: {\n id: \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n name: \"Main Team\"\n }\n}\n\nFields returned:
\nAll values returned by this request are real-time as of the moment you request them.
\n","urlObject":{"path":["api","pads",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"Id of the pad.
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"8d2f42ef-e4cd-4fdb-83e1-9cce17facc93","name":"Successful request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/pads/:id","host":["{{baseUrl}}"],"path":["api","pads",":id"],"variable":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Aug 2023 10:55:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"x-ua-compatible","value":"IE=edge"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"x-robots-tag","value":"none"},{"key":"vary","value":"Accept-Encoding,Origin"},{"key":"Content-Encoding","value":"identity"},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Cache-Control","value":"max-age=0"},{"key":"content-security-policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"x-request-id","value":"ae34cb92-ac14-4276-89b0-a0798769b1c6"},{"key":"x-runtime","value":"0.731418"},{"key":"via","value":"1.1 vegur"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"report-to","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=6xkSncUifzPWJqjH5P8RitR783qmrfdiNi7AtrVLRbTcy9ZNkF%2BJQUnpkNB4wD7TX4ExDlECPP01%2BbsREBHMUgyFJRclmYq%2F4jqiG3%2BTsFcTKwca29kVSVMgoEYhDn82yg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"nel","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"expires","value":"Wed, 02 Aug 2023 10:55:15 GMT"},{"key":"access-control-allow-origin","value":"https://coderpad.io"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f05c997fae78274-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"id\": \"983SDkjdsh\",\n \"title\": \"Untitled Pad - 983SDkjdsh\",\n \"state\": \"pending\",\n \"owner_email\": \"some.person@coderpad.io\",\n \"language\": \"postgresql\",\n \"private\": true,\n \"execution_enabled\": true,\n \"contents\": null,\n \"participants\": [\n \"some.person\"\n ],\n \"events\": \"https://app.coderpad.io/api/pads/983SDkjdsh/events\",\n \"notes\": null,\n \"created_at\": \"2023-08-02T10:27:51Z\",\n \"updated_at\": \"2023-08-02T10:29:49Z\",\n \"ended_at\": null,\n \"url\": \"https://coderpad.io/983SDkjdsh\",\n \"playback\": \"https://coderpad.io/983SDkjdsh/playback\",\n \"drawing\": null,\n \"type\": \"live\",\n \"question_ids\": [],\n \"pad_environment_ids\": [\n 1234567,\n 7654321\n ],\n \"active_environment_id\": 1234567,\n \"team\": {\n \"id\": \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"name\": \"Main Team\"\n }\n}"}],"_postman_id":"164f2132-4a50-4585-8b13-ddd442254a12"},{"name":"Retrieve a list of pad events","id":"c1a6a910-8b73-4f56-a929-3947c571af35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{{{api_key}}}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/pads/:id/events","description":"Returns detail about important events that transpired throughout the lifetime of the pad. It is represented as an array of objects with the following fields:
\nThis endpoint supports sorting and pagination similar to the /api/pads/ endpoint.
string Defaults to “Untitled Pad [ID]”.
string Defaults to the account default language, which in turn defaults to plaintext.
string Initial contents of pad. Defaults to the example code for the language. If you set contents, then you can’t set a question_id or the API will return an error. For accessing pad contents after any edits have been made you'll need to access file_contents.contents from GET /pad_environments/:id.
string Question to associate with this pad. When you set this, it behaves similarly as if you created a pad from a question on the website: the question language becomes the new pad’s language, and question contents become the pad’s contents. Note: If you set question_id, then you can’t set contents or the API will return an error.
string Any contents you would like to write to the Private Interviewer Notes in a pad.
boolean Defaults to the account default privacy setting, which in turn defaults to false.
boolean Defaults to the account default execution setting, which in turn defaults to true.
string The email of the user to set as the owner of this pad, e.g. vincent@coderpad.io. This parameter can only be set by owners of the organization. This will also create a user account if necessary, as long as the email is a valid one for your organization.
string The team id of the team this pad must be linked to, e.g. 4a0f61a3-3013-49f5-9eb7-9f83712a49bf
Create a new pad. You can set some initial conditions as well.
\ncurl \\\n --data title=\"Rob Zombie's Interview\" \\\n --data language=\"ruby\" \\\n --data contents=\"print 'Hello, World'\" \\\n --data notes=\"Your private notes\" \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/pads\n\nreturns
\n{\n \"status\": \"OK\",\n \"id\": \"AFQ2K9A3\",\n \"title\": \"Rob Zombie's Interview\",\n \"owner_email\": \"fbueller@gmail.com\",\n \"language\": \"ruby\",\n \"participants\": [\"vincent\"],\n \"contents\": \"print 'Hello, World'\",\n \"notes\": \"Your private notes\",\n \"events\": \"https://app.coderpad.io/api/pads/AFQ2K9A3/events\",\n \"private\": false,\n \"execution_enabled\": true,\n \"created_at\": \"2014-11-14T03:02:45Z\",\n \"updated_at\": \"2014-11-14T03:02:45Z\",\n \"ended_at\": null,\n \"url\": \"https://coderpad.io/AFQ2K9A3\",\n \"playback\": \"https://coderpad.io/AFQ2K9A3/playback\",\n \"history\": \"https://coderpad.firebaseio.com/AFQ2K9A3/history.json\",\n \"drawing\": null,\n \"pad_environment_ids\": [\n 1234567,\n 7654321\n ],\n \"active_environment_id\": 1234567,\n \"team\": {\n \"id\": \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"name\": \"Main Team\"\n }\n}\n\nThis method can return a quota exceeded error if you are over your used pad limit for the month.
\n","urlObject":{"path":["api","pads",""],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7d205277-6675-4744-8390-f01a487b83ac","name":"Successful request","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"API question","description":"Defaults to “Untitled Pad [ID]”.","type":"text"},{"key":"language","value":"ruby","description":"Defaults to the account default language, which in turn defaults to `plaintext`.","type":"text"},{"key":"contents","value":"","description":"Initial contents of pad. Defaults to the example code for the language. Note: If you set `contents`, then you can’t set a `question_id` or the API will return an error.","type":"text"},{"key":"question_id","value":"244308","description":"Question to associate with this pad. When you set this, it behaves similarly as if you created a pad from a question on the website: the question language becomes the new pad’s language, and question contents become the pad’s contents. Note: If you set `question_id`, then you can’t set `contents` or the API will return an error.","type":"text"},{"key":"notes","value":"None yet","description":"Any contents you would like to write to the Private Interviewer Notes in a pad.","type":"text"},{"key":"private","value":"true","description":"Defaults to the account default privacy setting, which in turn defaults to `false`.","type":"text"},{"key":"execution_enabled","value":"true","description":"Defaults to the account default execution setting, which in turn defaults to `true`.","type":"text"},{"key":"user_email","value":"ken@coderpad.io","description":"The email of the user to set as the owner of this pad, e.g. `vincent@coderpad.io`. This parameter can only be set by owners of the organization. This will also create a user account if necessary, as long as the email is a valid one for your organization.","type":"text"},{"key":"team_id","value":"68264172-5a54-4ac3-962b-cb8d1ad15d05","description":"The team id of the team this pad must be linked to, e.g. `4a0f61a3-3013-49f5-9eb7-9f83712a49bf`","type":"text","uuid":"12a60b3b-7d47-43d5-b3d0-17f357420271"}]},"url":"{{baseUrl}}/api/pads/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 11 Aug 2023 18:50:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Ua-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Robots-Tag","value":"none"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Etag","value":"W/\"4efaf72064335054dacafa402ea1d458\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"Set-Cookie","value":"_coderpad_rails_session_3=a9085f65b34eb3a378bf0fb7a61b5035; domain=.coderpad.io; path=/; secure; HttpOnly; SameSite=Lax"},{"key":"X-Request-Id","value":"44fd55d4-da5d-484d-970b-ed7d5878794f"},{"key":"X-Runtime","value":"0.556391"},{"key":"Via","value":"1.1 vegur"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=zt6PjBlxIxBLyn%2BsA2J1qk94yQmafkd7KS8mGl2S%2FCPR9nOAsIzwd7S%2F3JUi0c48AK2nnNYbjXq5WXAf4lLspnHkgRkixELpcVfyBpLbdTnQPRiYIR09G028FpRWsw9%2FTQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f52a9b49c142034-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"id\": \"ABC1234\",\n \"title\": \"Untitled Pad - ABC1234\",\n \"state\": \"pending\",\n \"owner_email\": \"ken@coderpad.io\",\n \"language\": \"javascript\",\n \"private\": true,\n \"execution_enabled\": true,\n \"contents\": null,\n \"participants\": [],\n \"events\": \"https://app.coderpad.io/api/pads/ABC1234/events\",\n \"notes\": null,\n \"created_at\": \"2023-08-11T18:50:12Z\",\n \"updated_at\": \"2023-08-11T18:50:12Z\",\n \"ended_at\": null,\n \"url\": \"https://coderpad.io/ABC1234\",\n \"playback\": \"https://coderpad.io/ABC1234/playback\",\n \"history\": \"https://coderpad-5.firebaseio.com/ABC1234/history.json\",\n \"drawing\": null,\n \"type\": \"live\",\n \"question_ids\": [],\n \"pad_environment_ids\": [\n 5018867\n ],\n \"active_environment_id\": null,\n \"team\": {\n \"id\": \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"name\": \"Main Team\"\n }\n}"}],"_postman_id":"b2785a73-5b4b-4d17-8239-d0d50929cc3c"},{"name":"Modify a pad","id":"377ee47a-4b41-4b8a-9d1f-08a662e2ca7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{{{api_key}}}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","type":"text","description":"string Defaults to “Untitled Pad [ID]”.
string Defaults to the account default language, which in turn defaults to plaintext.
string Initial contents of pad. Defaults to the example code for the language. Note: If you set contents, then you can’t set a question_id or the API will return an error.
string Question to associate with this pad. When you set this, it behaves similarly as if you created a pad from a question on the website: the question language becomes the new pad’s language, and question contents become the pad’s contents. Note: If you set question_id, then you can’t set contents or the API will return an error.
string Any contents you would like to write to the Private Interviewer Notes in a pad.
boolean Defaults to the account default privacy setting, which in turn defaults to false.
boolean Defaults to the account default execution setting, which in turn defaults to true.
string The email of the user to set as the owner of this pad, e.g. vincent@coderpad.io. This parameter can only be set by owners of the organization. This will also create a user account if necessary, as long as the email is a valid one for your organization.
Modifies an existing pad. You can specify any of the valid parameters you used to create the pad.
\nYou may also use this endpoint to end the interview, by setting the ended attribute to true, or delete the interview, by setting the deleted attribute to true. Values other than true will be ignored.
curl \\\n -X PUT --data title=\"Interview with Greg\" \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/pads/AFQ2K9A3\n\nPlease note that resetting the contents in the middle of an ongoing interview session will probably break something. It will also destroy the history for that pad. Use with caution.
\n","urlObject":{"path":["api","pads",""],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"18a70fed-1e47-41a8-8545-0951f118c0da","name":"Successful request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"Are apples good?","type":"text"}]},"url":"{{baseUrl}}/api/pads/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Aug 2023 14:20:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Ua-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Robots-Tag","value":"none"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Etag","value":"W/\"f91924ee263f0f16771114170bca8e1e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"Set-Cookie","value":"_coderpad_rails_session_3=8a7366cd51b2d7268b8deef226174d91; domain=coderpad-staging.io; path=/; HttpOnly; SameSite=Lax; secure"},{"key":"X-Request-Id","value":"9bf3bbfc-e45a-4304-97d8-51673f9f65db"},{"key":"X-Runtime","value":"0.034633"},{"key":"Via","value":"1.1 vegur"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=%2Fth%2FuClORs8iRwWlGFysbAXd3uTobUJPZbFyHf%2FWIS22I9VjgETLjgDSLjqf%2FsEF5AKoIM5GceuVZD2XRtQo8CigJYpMcjPVLJXR9Eed0LKf67nhNXNZ68vx4ZPIr6bwh%2FNspgkvpX2c\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f06f6e95b0c58cc-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"}],"_postman_id":"377ee47a-4b41-4b8a-9d1f-08a662e2ca7d"}],"id":"91c642dc-4a75-4bc0-9bb3-1184580f7d57","description":"Currently, the Interview API supports various operations on the pad endpoint: https://app.coderpad.io/api/pads. You can list pads, create pads, inspect a pad, or modify (in a limited fashion) existing pads.
Returns detail about a particular pad environment. Doing a straightforward curl like so:
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/pad_environments/42\n\nyields:
\n{\n \"status\": \"OK\",\n \"id\": 1,\n \"pad_id\": 3,\n \"question_id\": null,\n \"example_question_id\": null,\n \"language\": \"ruby\",\n \"file_contents\": [\n {\n \"path\": \"coderpad/main.rb\",\n \"contents\": \"5.times do\\n puts 'Hello, World!'\\nend\\n\"\n }\n ],\n \"created_at\": \"2022-09-12T13:49:45.390-07:00\",\n \"updated_at\": \"2022-09-12T13:50:42.058-07:00\"\n}\n\nFields returned:
\nThe file_contents field contains information about the files associated with the environment. It is represented as an array of objects with the following fields:
\nAll values returned by this endpoint are real-time as of the moment you request them.
\n","urlObject":{"path":["api","pad_environments",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[{"id":"928d6756-c93c-4675-b0a9-8feb1733e29f","name":"Successful request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/pad_environments/:id","host":["{{baseUrl}}"],"path":["api","pad_environments",":id"],"variable":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Aug 2023 16:10:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Ua-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Robots-Tag","value":"none"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Etag","value":"W/\"9c35de2f4e0a8a6067d5506d3f586b80\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"X-Request-Id","value":"fa89c053-4d89-4f7d-9fd3-66a7f13ffd59"},{"key":"X-Runtime","value":"0.228651"},{"key":"Via","value":"1.1 vegur"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=pB%2BQrmZ6IH6AvSRgAbuq5gMeWPpDySlr09kdbvJ7r1iZ5rViwhzFfTP19qcX%2BuZ%2BiIYwMzYkPASeiuHSMusyEqmICJmMlsy2%2F7pEfucIwF%2FGTfAQwoQ03oqzLtKNHNoNAg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0797673ee420cf-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"id\": 1234567,\n \"pad_id\": 88112233,\n \"question_id\": null,\n \"example_question_id\": null,\n \"language\": \"java\",\n \"file_contents\": [\n {\n \"path\": \"coderpad/Solution.java\",\n \"contents\": \"/*\\n * Click `Run` to execute the snippet below!\\n */\\n\\nimport java.io.*;\\nimport java.util.*;\\n\\n/*\\n * To execute Java, please define \\\"static void main\\\" on a class\\n * named Solution.\\n *\\n * If you need more classes, simply define them inline.\\n */\\n\\nclass Solution {\\n public static void main(String[] args) {\\n ArrayListReturns details about a particular question. You can view questions visible to you, which includes your own questions as well as colleagues’ questions where shared is set to true. If you’re an organization owner, you can view all questions in the organization.
curl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/questions/42\n\nyields:
\n{\n \"status\": \"OK\",\n \"id\": 42,\n \"title\": \"Are fruits tomatoes?\",\n \"author_name\": \"Molly Macadamia\",\n \"owner_email\": \"molly@macadamia.net\",\n \"language\": \"postgresql\",\n \"description\": \"Use SQL magic to discover the answer.\",\n \"contents\": \"SELECT * FROM fruits;\\n\",\n \"shared\": true,\n \"used\": 0,\n \"created_at\": \"2019-01-25T02:07:12Z\",\n \"updated_at\": \"2019-01-25T02:07:12Z\"\n}\n\nFields returned:
\n","urlObject":{"path":["api","questions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[{"id":"9b008373-3ab9-4aba-946b-d75ce85e4f68","name":"Successful request","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/questions/:id","host":["{{baseUrl}}"],"path":["api","questions",":id"],"variable":[{"key":"id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Aug 2023 17:59:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Ua-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Robots-Tag","value":"none"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Etag","value":"W/\"1642e67b00e362d11a88edbe1b4f3d76\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"X-Request-Id","value":"d229f1dd-6ece-4034-a0ab-728a3b127169"},{"key":"X-Runtime","value":"0.392650"},{"key":"Via","value":"1.1 vegur"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=APjnoi3XJJ%2FVA5OgGJcmboQpCh1i4HWFpmasq1hSv30DRAZSI8SAOycKZ4iOSGJREmuRRlbWOiK%2BjccE%2Bb%2FToFwWZjlGEv5mv7t6mHbV2ugY8QBtrVeZEgg9aubyixF4iw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f08365aef353ae4-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"id\": 123456,\n \"title\": \"Parking Lot OO\",\n \"owner_email\": \"ken@coderpad.io\",\n \"language\": \"csharp\",\n \"description\": \"Example coding question testing knowledge of object-oriented principles for use during candidate interviews.\",\n \"candidate_instructions\": [\n {\n \"instructions\": \"Hey candidate! Welcome to your interview. Boilerplate is provided. Feel free to change the code as you see fit. To run the code at any time, please hit the run button located in the top left corner.\\n\\nGoals:\\n Design a parking lot using object-oriented principles\\n\\n Here are a few methods that you should be able to run:\\n- Tell us how many spots are remaining\\n- Tell us how many total spots are in the parking lot\\n- Tell us when the parking lot is full\\n- Tell us when the parking lot is empty\\n- Tell us when certain spots are full e.g. when all motorcycle spots are taken\\n- Tell us how many spots vans are taking up\\n\\nAssumptions:\\n- The parking lot can hold motorcycles, cars and vans\\n- The parking lot has motorcycle spots, car spots and large spots\\n- A motorcycle can park in any spot\\n- A car can park in a single compact spot, or a regular spot\\n- A van can park, but it will take up 3 regular spots\\n- These are just a few assumptions. Feel free to ask your interviewer about more assumptions as needed \\n\",\n \"default_visible\": true\n }\n ],\n \"contents\": \"using System;\\n\\n// To execute C#, please define \\\"static void Main\\\" on a class\\n// named Solution.\\n\\nclass Solution\\n{\\n static void Main(string[] args)\\n {\\n for (var i = 0; i < 5; i++)\\n {\\n Console.WriteLine(\\\"Hello, World\\\");\\n }\\n }\\n}\\n\",\n \"shared\": true,\n \"used\": 1,\n \"take_home\": false,\n \"test_cases_enabled\": false,\n \"solution\": null,\n \"pad_type\": \"any\",\n \"is_draft\": false,\n \"author_name\": \"ken\",\n \"organization_name\": \"CoderPad\",\n \"custom_files\": [],\n \"created_at\": \"2023-03-13T13:30:18Z\",\n \"updated_at\": \"2023-03-13T13:32:06Z\"\n}"}],"_postman_id":"72b29b80-924e-4ea6-aeee-c7b0d81e90b6"},{"name":"Retrieve a list of questions","id":"d2fa48b3-dbfe-4b9b-af97-9a4df8562f1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{{{api_key}}}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/questions/","description":"Fetch a list of all of your questions. Returns all fields that an individual Get question by id request does.
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/questions?sort=updated_at,desc\n\nindex takes an optional sort parameter, which allows you to sort by either the created_at or updated_at fields on the questions. Adding a comma will allow you to change the sort direction, which is desc by default. For example, to sort your questions by updated_at from oldest to newest, specify updated_at,asc.
If no sort parameter is provided, created_at,desc is assumed.
The method also returns paginated results - no more than 50 per request. If you want more, follow the next_page or prev_page urls if present. The API also returns a total count to give you a sense of how many questions exist.
{\n \"status\": \"OK\",\n \"questions\": [\n // ... your questions, with the same data format as in `show`\n ],\n \"next_page\": \"https://app.coderpad.io/api/question?sort=updated_at,desc&page=2\",\n \"total\": 420\n}\n\nstring Title for this question.
string Notes for yourself (or colleagues) on what this question is about, and what good and bad answers might look like.
string Programming language or framework the question is written in.
string This text is inserted into your interview session if you choose to use this question.
string The text for the solution to your question.
array <object> Consists of two fields: \"instructions\", a string of text that describe the question to the candidate, and the \"default_visible\" field, a boolean that enables the candidate to see the instructions in the pad. Example:
{\n\"instructions\": \"These are candidate instructions\",\n\"default_visible\": true\n}\nCreate a new question.
\ncurl \\\n --data title=\"Are avocados fruity?\" \\\n --data description=\"Fruit puzzler round 2\" \\\n --data language=\"ruby\" \\\n --data contents=\"def is_fruity?(thing);\\n end\\n\" \\\n --data solution=\"This is the solution\" \\\n --data candidate_instructions=\"[{'instructions': 'Implement the is_fruity method'}]\" \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/questions\n\nreturns the question just created:
\n{\n \"status\": \"OK\",\n \"id\": 7,\n \"title\": \"Are avocados fruity?\",\n \"owner_email\": \"alice@fruits-party.io\",\n \"language\": \"ruby\",\n \"description\": \"Fruit puzzler round 2\",\n \"contents\": \"def is_fruity?(thing);\\n end\\n\",\n \"shared\": true,\n \"used\": 0,\n \"created_at\": \"2019-01-28T21:21:16Z\",\n \"updated_at\": \"2019-01-28T21:21:16Z\"\n}\n\nThe available paramters you have to configure are detailed below:
\n","urlObject":{"path":["api","questions",""],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"69539184-188f-4ab2-a629-28037e12aefb","name":"Successful request","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"question[title]","value":"Are avocados fruity?","type":"text"},{"key":"description","value":"Fruit puzzler round 2","type":"text"},{"key":"question[language]","value":"ruby","type":"text"},{"key":"contents","value":"def is_fruity?(thing);\\n end\\n","type":"text"},{"key":"solution","value":"This is the solution","type":"text"},{"key":"candidate_instructions","value":"[{'instructions': 'Implement the is_fruity method'}]","type":"text"}]},"url":"{{baseUrl}}/api/questions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 11:32:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Ua-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Robots-Tag","value":"none"},{"key":"Vary","value":"Accept-Encoding, Origin"},{"key":"Etag","value":"W/\"12bcb32dc651c297dacc827e20d5d924\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"X-Request-Id","value":"8e770d56-c86d-4d41-b867-7dc1e1d7fc77"},{"key":"X-Runtime","value":"0.056612"},{"key":"Via","value":"1.1 vegur"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=kTE4f3HJ%2FntQ8lC9WGiDgSkURK6OdkFvyVkSAhZcZwHagzMOKBeZwX4uwRvN%2BllvlwVlZUp1BwfGCtZAaQumHRVmsMudAcABDTvCAZtz6zSuYGOj92ymZ%2FVQ3isu%2BM4keA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0e3e2e9a91826f-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"id\": 255896,\n \"title\": \"Are avocados fruity?\",\n \"owner_email\": \"ken@coderpad.io\",\n \"language\": \"ruby\",\n \"description\": null,\n \"candidate_instructions\": [],\n \"contents\": null,\n \"shared\": true,\n \"used\": 0,\n \"take_home\": false,\n \"test_cases_enabled\": false,\n \"solution\": null,\n \"pad_type\": \"live\",\n \"is_draft\": false,\n \"author_name\": \"ken\",\n \"organization_name\": \"CoderPad\",\n \"custom_files\": [],\n \"created_at\": \"2023-08-03T11:32:56Z\",\n \"updated_at\": \"2023-08-03T11:32:56Z\"\n}"}],"_postman_id":"3b18d509-0edf-46fd-b906-c2753613f581"},{"name":"Modify a question","id":"ea123846-ed8c-4d94-a202-e746ca000606","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{{{api_key}}}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"question[title]","value":"","description":"string Title for this question.
string Notes for yourself (or colleagues) on what this question is about, and what good and bad answers might look like.
string Programming language or framework the question is written in.
string This text is inserted into your interview session if you choose to use this question.
string The text for the solution to your question.
array <object> Consists of two fields: \"instructions\", a string of text that describe the question to the candidate, and the \"default_visible\" field, a boolean that enables the candidate to see the instructions in the pad. Example:
{\n\"instructions\": \"These are candidate instructions\",\n\"default_visible\": true\n}\nModifies an existing question. You can specify any of the valid parameters to create.
curl \\\n -X PUT --data description=\"We've noticed candidates from the West coast have substantial experience with avocados, so this question is worth less points now.\" \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/questions/42\n\nDeletes an existing question. There is no undo!
\ncurl \\\n -X DELETE \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/questions/42\n\nThe Interview API supports most operations on the questions endpoint: https://app.coderpad.io/api/questions. You can list questions, create questions, view questions, modify existing questions, or delete existing questions.
This endpoint returns basic information about your organization’s monthly pad quota (or your quota, if you are not a part of an organization). For example, if you are a user in an organization with a monthly quota of 120 pads, the following:
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/quota\n\nreturns:
\n{\n \"status\": \"OK\",\n \"trial_expires_at\": \"2018-01-30T16:16:00.000-08:00\",\n \"pads_used\": 33,\n \"quota_reset_at\": \"2018-01-25T14:51:37.084-08:00\",\n \"unlimited\": false,\n \"pads_remaining\": 87,\n \"billing_cycle_pad_limit\": 120\n}\n\nFields returned:
\n","urlObject":{"path":["api","quota"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"8223ba32-3e35-47f0-a330-5a1add8061c3","name":"Successful request","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/api/quota"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Aug 2023 12:13:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Ua-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Vary","value":"Accept, Accept-Encoding, Origin"},{"key":"X-Robots-Tag","value":"none"},{"key":"Etag","value":"W/\"f784baab0651711d7b1c69f119ea36b6\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Security-Policy","value":"default-src 'self' https: blob:; connect-src 'self' ws: https: wss: file: https://edge.fullstory.com https://rs.fullstory.com https://sentry.io; img-src 'self' https: data: http: blob: https://www.googletagmanager.com https://rs.fullstory.com; object-src 'none'; script-src 'self' https: https://*.firebaseio.com https://www.googletagmanager.com https://edge.fullstory.com https://rs.fullstory.com https://js.hs-analytics.net https://www.google-analytics.com https://connect.facebook.net https://widget.intercom.io 'unsafe-inline' 'unsafe-eval'; worker-src 'self' https: blob:; style-src 'self' https: blob: 'unsafe-inline' 'unsafe-eval'; media-src 'self' https: data: blob:; font-src 'self' https: data: chrome-extension moz-extension https://fonts.gstatic.com http://themes.googleusercontent.com; report-uri /csp-report"},{"key":"X-Request-Id","value":"0f592453-4e85-46a5-97c3-3ed9510b6520"},{"key":"X-Runtime","value":"0.046574"},{"key":"Via","value":"1.1 vegur"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=8sRcUIrwzPWReKUdWTQpFhKjc44Mcz6ZlHksNJmZZTOAFS77mwqkRFxeb9SFibhJpdohN4Yo1NmTaxjE12QXsqEa%2BYGkmzLL2%2FwLMbZaV8a1%2BGUiHP0RdDih2XmB0uE82g%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f0e7998997e8006-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"trial_expires_at\": \"2023-06-07T05:30:11.437-07:00\",\n \"pads_used\": 270,\n \"quota_reset_at\": \"2023-07-16T20:11:59.208-07:00\",\n \"unlimited\": true,\n \"overages_enabled\": false\n}"}],"_postman_id":"f64865fb-5368-4007-9360-86801f473a3b"}],"id":"0f90513b-a9e6-44e8-ada2-d8402295b681","_postman_id":"0f90513b-a9e6-44e8-ada2-d8402295b681","description":""},{"name":"Organization","item":[{"name":"Retrieve account info","id":"1c417d9d-f7d5-40a9-90aa-4c0eb0bf6ee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{{{api_key}}}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/api/organization","description":"This endpoint returns basic information about your organization, including whether or not your organization makes use of a single-sign-on service for authentication.
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n https://app.coderpad.io/api/organization\n\nreturns
\n{\n \"status\": \"OK\",\n \"organization_name\": \"ACME Computing\",\n \"user_count\": 137,\n \"users\": [\n {\n \"email\": \"wile@acme.com\",\n \"name\": \"Wile Coyote\",\n \"teams\": [\n \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"4a0f61a3-3013-49f5-9eb7-9f83712a49bf\"\n ]\n }\n // ... followed by the rest of the users in your org.\n ],\n \"default_language\": \"erlang\", // default language for new users in your organization\n \"single_sign_on_supported\": true, // users will be directed to login via the single sign in portal\n \"single_sign_in_url\": acme.coderpad.io, // the url for that portal.\n \"teams\": [ // The teams names and ids\n {\n \"id\": \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"name\": \"Main Team\"\n },\n {\n \"id\": \"4a0f61a3-3013-49f5-9eb7-9f83712a49bf\",\n \"name\": \"Second Team\"\n },\n {\n \"id\": \"ddc4ce0a-93ec-4bad-9a1a-3d2db96f6220\",\n \"name\": \"Third Team\"\n }\n ]\n}\n\nThis endpoint returns statistics about how many pads the members of your organization have created. By default the endpoint will return information about the last 7 days, but you can configure the time range as well.
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n \"https://app.coderpad.io/api/organization/stats?\\\nstart_time=2015-12-07T00:31:52Z&\\\nend_time=2015-12-15T00:31:52Z\"\n\nreturns
\n{\n status: \"OK\",\n // The computed start/end times are always returned,\n // even with the default window\n start_time: 2023-07-23T12:27:05Z,\n end_time: 2023-07-31T12:27:05Z,\n pads_created: 137,\n users: [\n {\n email: \"person@place.com\",\n name: \"Person Surname\",\n pads_created: 7\n },\n {\n email: \"confidant@place.com\",\n name: \"Confidant Methodical\",\n pads_created: 0\n },\n // ... followed by the rest of the users in your org\n ]\n}\n\nThis endpoint is similar to the Get a list of pads operation, except that it returns all the pads in your organization. To access this endpoint, your user must be an organization owner, or your organization must allow all pads to be visible to its users. This last setting is default on, but you can email us to disable this feature.
\nThe endpoint also performs sorting and pagination identically to Get a list of pads.
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n \"https://app.coderpad.io/api/organization/pads?sort=updated_at,desc\"\n\nreturns
\n{\n \"status\": \"OK\",\n \"pads\": [\n {\n \"id\": \"PP7J474P\",\n \"title\": \"JavaScript Test\",\n \"owner_email\": \"kristin@coderpad.io\",\n \"language\": \"javascript\",\n \"participants\": [\"Kristin\", \"Guest 104\"],\n \"contents\": \"var _ = require('underscore');\\n...\",\n \"private\": false,\n \"execution_enabled\": true,\n \"events\": \"https://app.coderpad.io/api/pads/PP7J474P/events\",\n \"notes\": \"Brenda did a fantastic job talking through the prompt ...\",\n \"created_at\": \"2018-02-13T02:06:30Z\",\n \"updated_at\": \"2018-02-13T06:21:26Z\",\n \"ended_at\": null,\n \"url\": \"https://coderpad.io/PP7J474P\",\n \"playback\": \"https://coderpad.io/PP7J474P/playback\",\n \"history\": \"https://coderpadproject.firebaseio.com/PP7J474P/history.json\",\n \"drawing\": \"https://storage.googleapis.com/...\",\n \"team\": {\n \"id\": \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"name\": \"Main Team\"\n }\n }\n // ... followed by a list of the rest of the pads in the organization\n ],\n \"next_page\": \"https://app.coderpad.io/api/organization/pads?sort=updated_at,desc&page=2\",\n \"total\": 512\n}\n\nThis endpoint is similar to GET /api/questions, except that it returns all the questions in your organization visible to you. You’ll see your own questions as well as colleagues’ questions where the shared boolean is set to true. If you are an organization owner, you can see every question in the organization.
The endpoint also performs sorting and pagination identically to GET /api/questions.
\ncurl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n \"https://app.coderpad.io/api/organization/questions?sort=updated_at,desc\"\n\nreturns
\n{\n \"status\": \"OK\",\n \"questions\": [\n {\n \"id\": 12,\n \"title\": \"Are avocados fruity?\",\n \"owner_email\": \"alice@fruits-party.io\",\n \"language\": \"ruby\",\n \"description\": \"Fruit puzzler round 2?\",\n \"contents\": \"def is_fruity?(thing);\\\\n end\\\\n\",\n \"shared\": true,\n \"used\": 0,\n \"created_at\": \"2019-01-28T22:08:09Z\",\n \"updated_at\": \"2019-01-28T22:08:09Z\"\n }\n // ... followed by the rest of the questions in the organization visible to you\n ],\n \"next_page\": \"https://app.coderpad.io/api/organization/questions?sort=updated_at,desc&page=2\",\n \"total\": 256\n}\n\nThis endpoint is similar to GET /api/organization, except that it returns only the users list of that organization. If the email attribute is set, it returns only the user corresponding to that email.
curl \\\n -H 'Authorization: Token token=\"8af9a3412559d803707937250dc1569d\"' \\\n \"https://app.coderpad.io/api/organization/pads?email=buddy@company.io\"\n\nreturns
\n{\n \"status\": \"OK\",\n \"users\": [\n {\n \"email\": \"buddy@company.io\",\n \"name\": \"Buddy\",\n \"teams\": [\n \"68264172-5a54-4ac3-962b-cb8d1ad15d05\",\n \"ddc4ce0a-93ec-4bad-9a1a-3d2db96f6220\"\n ]\n }\n ] \n}\n\nThis endpoint allows you to access information about your organization, should you be a member of one: https://app.coderpad.io/api/organization.