This template guides you through CRUD operations (GET, POST, PUT, DELETE), variables, and tests.
\nRESTful APIs allow you to perform CRUD operations using the POST, GET, PUT, and DELETE HTTP methods.
\nThis collection contains each of these request types. Open each request and click \"Send\" to see what happens.
\nObserve the response tab for status code (200 OK), response time, and size.
\nUpdate or add new data in \"Body\" in the POST request. Typically, Body data is also used in PUT request.
\n{\n \"name\": \"Add your name in the body\"\n}\n\nVariables enable you to store and reuse values in Postman. We have created a variable called base_url with the sample request https://postman-api-learner.glitch.me. Replace it with your API endpoint to customize this collection.
Adding tests to your requests can help you confirm that your API is working as expected. You can write test scripts in JavaScript and view the output in the \"Test Results\" tab.
\nUse folders to group related requests and organize the collection.
\nAdd more scripts to verify if the API works as expected and execute workflows.
\nAPI testing basics
API documentation
Authorization methods
Registers a new user account in the Studingo platform.
\nMethod: POST
URL: http://127.0.0.1:8000/api/register
Request Body (form-data):
Headers: None required
\nQuery Parameters: None
\nExpected Response:
\n201 Created — User registered successfully. Response body typically includes the new user's details and/or an access token.
422 Unprocessable Entity — Validation failed (e.g., email already taken, passwords do not match).
Authenticates an existing user and returns an access token for use in subsequent protected requests.
\nMethod: POST
URL: http://127.0.0.1:8000/api/login
Request Body (form-data):
Headers: None required
\nQuery Parameters: None
\nExpected Response:
\n200 OK — Login successful. The response body includes an access_token that must be passed in the access_token header for all protected endpoints.
401 Unauthorized — Invalid credentials.
422 Unprocessable Entity — Validation error (e.g., missing fields).
Logs out the currently authenticated user by invalidating their access token.
\nMethod: POST
URL: http://127.0.0.1:8000/api/logout
Request Headers:
\nQuery Parameters: None
\nRequest Body: None
\nExpected Response:
\n200 OK — Logout successful. The token is invalidated and can no longer be used.
401 Unauthorized — Token is missing or already invalid.
The Auth folder contains endpoints for managing user identity and sessions in the Studingo API.
\nThese endpoints handle the full authentication lifecycle: registering a new account, logging in to receive an access token, and logging out to invalidate the current session.
\nAuthentication flow:
\nRegister a new user account via POST /api/register.
Log in with credentials via POST /api/login to receive an access_token.
Include the token in the access_token header for all protected requests.
Log out via POST /api/logout to invalidate the token.
Registration requires a name, phone number, email, and a confirmed password. Login requires only email and password. Logout requires the active access_token to be passed in the request header.
Retrieves a list of all goals stored in the system.
\nMethod: GET
URL: http://127.0.0.1:8000/api/allGoals
Headers: None
\nQuery Parameters: None
\nRequest Body: None
\nExpected Response:
\n200 OK — Returns a JSON array of all goal objects. Each goal typically includes an id, name, desc, and user_id.Test Script: None saved on this request.
\n","urlObject":{"protocol":"http","port":"8000","path":["api","allGoals"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6e69552-6b14-4a1b-9f4a-1bd3f37ef003"},{"name":"Create Goal","id":"30497034-5439-4426-ac37-a88ff8809d08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"leo messi","type":"text","uuid":"9351ce1a-377e-43e2-8cd1-eec484534e6b"},{"key":"desc","value":"Uncel of the worled","type":"text","uuid":"ad8becb9-6629-4a23-b20d-247660f70946"},{"key":"user_id","value":"3","type":"text","uuid":"47fa0dae-328b-44bf-8c60-65be87e6f83b"}]},"url":"http://127.0.0.1:8000/api/addGoal","description":"StartFragment
\nMethod: POST URL: http://127.0.0.1:8000/api/addGoal
Description: Creates a new goal for a user. The request uses form-data body mode to submit the goal details.
Headers: None
\nQuery Parameters: None
\nRequest Body (form-data):
Test Script: None
\nExpected Response: 200 OK or 201 Created
Saved Examples: None
\nEndFragment
\n","urlObject":{"protocol":"http","port":"8000","path":["api","addGoal"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"30497034-5439-4426-ac37-a88ff8809d08"},{"name":"Delete Goal","id":"0541feb7-98c6-470a-81e6-9fa76ec6f5da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"access_token","value":"JNBBDJGb1Lo8UIeRkncq9bXpkMAfR7NpnC6XscAnZGzeo7XhM5Wk3cN8jQutSdPZ","type":"text"}],"url":"http://127.0.0.1:8000/api/deleteGoal/30","description":"The goals folder contains endpoints for managing user goals in the Studingo API.
\nGoals are personal objectives associated with a specific user, identified by a user_id. Each goal has a name and a description. This folder covers the full lifecycle of a goal: listing all goals, creating a new one, and deleting an existing one by its ID.
All goal endpoints use form-data for request bodies where applicable. The Delete Goal endpoint uses a path parameter to identify the target goal — the ID is embedded directly in the URL (e.g., /api/deleteGoal/30).
These endpoints do not currently require authentication headers based on the saved request structure, but it is recommended to pass the access_token header for protected access in production environments.
StartFragment
\nMethod: GET URL: http://127.0.0.1:8000/api/allFiles
Description: Retrieves a list of all files. This is a standard GET request with no request body. Query parameters can be used to filter or specify the resource if needed.
\nA successful response returns a 200 OK status with a JSON body containing the file list.
Headers: None
\nQuery Parameters: None
\nRequest Body: None
\nTest Script:
\npm.test(\"Status code is 200\", function () { pm.response.to.have.status(200);});\n\nExpected Response: 200 OK
EndFragment
\n","urlObject":{"protocol":"http","port":"8000","path":["api","allFiles"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6547e91-4e1a-45b2-987b-5d81522b3866"},{"name":"GetFile","event":[{"listen":"test","script":{"id":"94009645-ec8d-4bbf-826e-d16f4c846011","exec":["pm.test(\"Successful POST request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 201]);","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4d5bae62-7f82-4307-b9ff-6a89449504c3","request":{"method":"GET","header":[{"key":"accsee_token","value":"JNBBDJGb1Lo8UIeRkncq9bXpkMAfR7NpnC6XscAnZGzeo7XhM5Wk3cN8jQutSdPZ","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Add your name in the body\"\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/show/3","description":"Uploads a new file along with its associated metadata. Uses multipart/form-data to support binary file content alongside text fields.
Method: POST
URL: http://127.0.0.1:8000/api/uploadFile
StartFragment
\nMethod: POST URL: http://127.0.0.1:8000/api/uploadFile
Description: Uploads a new file along with associated metadata. The request uses multipart/form-data (form-data body mode) to support file binary upload alongside text fields.
A successful response returns 200 OK, 201 Created, or 204 No Content.
Headers: None (Content-Type is set automatically by Postman for form-data)
\nQuery Parameters: None
\nRequest Body (form-data):
Test Script:
\npm.test(\"Successful PUT request\", function () { pm.expect(pm.response.code).to.be.oneOf ([200, 201, 204]);});\n\nExpected Response: 200 OK, 201 Created, or 204 No Content
EndFragment
\n","urlObject":{"protocol":"http","port":"8000","path":["api","uploadFile"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"07257a37-7b99-4118-ac7f-68c8e1448410"},{"name":"Delete File","event":[{"listen":"test","script":{"id":"95de54c9-540c-46b3-a88f-2a522370a17e","exec":["pm.test(\"Successful DELETE request\", function () {"," pm.expect(pm.response.code).to.be.oneOf([200, 202, 204]);","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"deac88dc-c4d6-4d43-a0d8-32d117f1708b","request":{"method":"DELETE","header":[{"key":"access_token","value":"JNBBDJGb1Lo8UIeRkncq9bXpkMAfR7NpnC6XscAnZGzeo7XhM5Wk3cN8jQutSdPZ","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/deleteFile/16","description":"StartFragment
\nMethod: DELETE URL: http://127.0.0.1:8000/api/deleteFile/16
Description: Deletes a file identified by its ID in the URL path (e.g., /deleteFile/16). No request body is required.
A successful response returns 200 OK, 202 Accepted, or 204 No Content.
Headers: None
\nQuery Parameters: None
\nPath Parameter:
\nRequest Body: None
\nTest Script:
\npm.test(\"Successful DELETE request\", function () { pm.expect(pm.response.code).to.be.oneOf ([200, 202, 204]);});\n\nExpected Response: 200 OK, 202 Accepted, or 204 No Content
Saved Examples: None
\n","urlObject":{"protocol":"http","port":"8000","path":["api","deleteFile","16"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[],"_postman_id":"deac88dc-c4d6-4d43-a0d8-32d117f1708b"}],"id":"90e6133d-a86f-47d2-b411-dbea8bfc6c79","_postman_id":"90e6133d-a86f-47d2-b411-dbea8bfc6c79","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"id":"530bbdd9-38d3-441e-92dc-61f171c18dc2","key":"id","value":"1"},{"id":"57b5ecc1-1ffd-4eb5-a9a4-fa78c5251c5d","key":"base_url","value":"https://template.postman-echo.com"}]}