Manage books in the Postman library using this API. This API is designed to teach the basics of using APIs and Postman!
\nNote that all non-permanent collection books are automatically deleted on a three-day rolling basis
\nSome books are part of the permanent collection and cannot be edited or deleted. These books have the property isPermanentCollection: true
This API requires Authorization to make POST, PATCH, and DELETE requests.
\nYou will need to set the API key in the collection variables to postmanrulz in order to make those requests.
In the real world you would generate an API Key with an API's developer portal service. This is just a training API so we have provided an API key for you!
\nLearn more about authorizing API requests in Postman here.
\nAny book you add or update will be publicly visible to all users of this API. Please be respectful and follow these rules:
\nOnly modify books you have added yourself
\nUnderstand that books in this API may be deleted at any time
\nThe old Library API was used in the Postman Classroom Program modules. We made some improvements for v2:
\nAPI Key Auth for POST/PATCH/DELETE requests. Practice authorization!
\nPOST/PATCH requests now return book info such as id. This enables possibilities with scripting based on the response.
Dedicated public workspace and docs. You can view this API's schema from the \"API\" tab in the public workspace. Easily find and fork this API or docs by searching \"Postman Library API v2\"
\nAutomatic cleanup. Non-permanent collection books are automatically deleted on a rolling three-day basis.
\nProfanity filters. Cleans up book titles and author names
\n(Required) the id of a book
\n","type":"text/plain"},"type":"any","value":"29cd820f-82f9-4b45-a7f4-0924111b5b89","key":"id"}]}},"response":[{"id":"bded5c6a-0173-4b2f-b532-dce74f37cb4f","name":"Found book","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://library-api.postmanlabs.com/books/:id","host":["https://library-api.postmanlabs.com"],"path":["books",":id"],"variable":[{"key":"id","value":"29cd820f-82f9-4b45-a7f4-0924111b5b89","description":"(Required) the id of a book"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"29cd820f-82f9-4b45-a7f4-0924111b5b89\",\n \"title\": \"Ficciones\",\n \"author\": \"Jorge Luis Borges\",\n \"genre\": \"fiction\",\n \"yearPublished\": 1944,\n \"checkedOut\": false,\n \"isPermanentCollection\": true,\n \"createdAt\": \"2022-03-04T22:10:24.526Z\"\n }"},{"id":"ea08218e-8656-4852-b06d-3765ef70eca3","name":"Book not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://library-api.postmanlabs.com/books/:id","host":["https://library-api.postmanlabs.com"],"path":["books",":id"],"variable":[{"key":"id","value":"29cd820f-82f9-4b45-a7f4-0924111b5b80","description":"(Required) the id of a book"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Book with id '29cd820f-82f9-4b45-a7f4-0924111b5b80 not found\"\n}"},{"id":"0090e49f-ad43-4f38-b495-6d4d70b13ec6","name":"Unexpected error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://library-api.postmanlabs.com/books/:id","host":["https://library-api.postmanlabs.com"],"path":["books",":id"],"variable":[{"key":"id","value":"fugiat amet in aliquip Excepteur","description":"(Required) the id of a book"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"something\"\n}"}],"_postman_id":"b042476f-a942-497d-af90-b014f5c4a4ce"},{"name":"Update a book by id","id":"1c3ce860-e1ee-4957-b517-2e3068021abc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"checkedOut\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://library-api.postmanlabs.com/books/:id","urlObject":{"path":["books",":id"],"host":["https://library-api.postmanlabs.com"],"query":[],"variable":[{"id":"7dd255c5-a17c-46f4-be5e-4aa6cf50f195","description":{"content":"(Required) the id of a book
\n","type":"text/plain"},"type":"any","value":"29cd820f-82f9-4b45-a7f4-0924111b5b89","key":"id"}]}},"response":[{"id":"4647a9a6-4680-4d6d-8bb2-b361edff6aab","name":"Update successful","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: apikey","key":"api-key","value":"(Required) the id of a book
\n","type":"text/plain"},"type":"any","value":"29f47d22-1062-479d-be58-2d8db3ecb8be","key":"id"}]}},"response":[{"id":"e780ebf8-1bf7-4c57-80fe-f96f271828fb","name":"Delete successful","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"api-key","value":"Get all books, or add query parameters to filter results by genre, search keyword, and/or checkedOut status
a genre to filter for
\n","type":"text/plain"},"key":"genre","value":"fiction"},{"disabled":true,"description":{"content":"a value true or false
\n","type":"text/plain"},"key":"checkedOut","value":"false"},{"disabled":true,"description":{"content":"a search term to match against author or title
\n","type":"text/plain"},"key":"search","value":"borges"}],"variable":[]}},"response":[{"id":"1bb4951e-2122-456d-8100-532a68556fde","name":"A list of all books","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://library-api.postmanlabs.com/books?genre=fiction&checkedOut=false","host":["https://library-api.postmanlabs.com"],"path":["books"],"query":[{"key":"genre","value":"fiction"},{"key":"checkedOut","value":"false"},{"key":"search","value":"borges","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"50b1a8e9-78f0-4a80-b350-8fdf8fb1b8b8\",\n \"title\": \"A Thousand Splendid Suns\",\n \"author\": \"Khaled Hosseini\",\n \"genre\": \"fiction\",\n \"yearPublished\": 2007,\n \"checkedOut\": false,\n \"isPermanentCollection\": true,\n \"createdAt\": \"2022-03-04T22:10:24.526Z\"\n },\n {\n \"id\": \"29cd820f-82f9-4b45-a7f4-0924111b5b89\",\n \"title\": \"Ficciones\",\n \"author\": \"Jorge Luis Borges\",\n \"genre\": \"fiction\",\n \"yearPublished\": 1944,\n \"checkedOut\": false,\n \"isPermanentCollection\": true,\n \"createdAt\": \"2022-03-04T22:10:24.526Z\"\n }\n]"},{"id":"30eec829-9606-48b6-9944-3cb9657b2ec4","name":"Unexpected error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://library-api.postmanlabs.com/books?genre=fugiat amet in aliquip Excepteur&checkedOut=fugiat amet in aliquip Excepteur&search=fugiat amet in aliquip Excepteur","host":["https://library-api.postmanlabs.com"],"path":["books"],"query":[{"key":"genre","value":"fugiat amet in aliquip Excepteur"},{"key":"checkedOut","value":"fugiat amet in aliquip Excepteur"},{"key":"search","value":"fugiat amet in aliquip Excepteur"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"something\"\n}"}],"_postman_id":"a2f33f71-de38-42fb-97fe-dccac7516e73"},{"name":"Add a book","id":"e0dbc14c-371d-4813-97c3-281de36fad0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"The Four Agreements\",\n \"author\": \"don Miguel Ruiz\",\n \"genre\": \"self-help\",\n \"yearPublished\": 1997\n}","options":{"raw":{"language":"json"}}},"url":"https://library-api.postmanlabs.com/books","description":"Note: User-added books are automatically deleted about 3 days after being added.
\n","urlObject":{"path":["books"],"host":["https://library-api.postmanlabs.com"],"query":[],"variable":[]}},"response":[{"id":"7d1b5576-2db5-4b40-abaf-62d1925898f2","name":"Book created successfully","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"api-key","value":"