API for managing legal users, including clients, attorneys, and admins
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34526223","collectionId":"28962c3d-35b8-45b8-93ba-c4e6c3d605da","publishedId":"2sB2qZFNbW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-05-21T12:42:54.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login","event":[{"listen":"test","script":{"id":"2fe8e4ed-2787-475f-8e7c-58310579d048","exec":["let response = pm.response.json();","","if (response.data.access_token) {"," pm.globals.set(\"bearer_token\", response.data.access_token);"," console.log(\"Access token set:\", response.data.access_token);","} else {"," console.error(\"Access token not found in response.\");","}","","if (response.data.user.id){"," pm.globals.set(\"userid\", response.data.user.id);"," console.log(\"userid:\", response.data.user.id);","} else{"," console.error(\"User Id not found in respoinse.\")","}"],"type":"text/javascript","packages":{}}}],"id":"6903e5c5-c0b2-4caf-b666-70227945afea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"anekahiwot@gmail.com\",\n \"password\": \"StrongPassword123!\"\n}"},"url":"http://127.0.0.1:8000/api/login","description":"Login to get access token
\n","urlObject":{"path":["api","login"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[]}},"response":[],"_postman_id":"6903e5c5-c0b2-4caf-b666-70227945afea"}],"id":"a6aaba94-24e7-4c47-991e-8e59ecdfaf45","_postman_id":"a6aaba94-24e7-4c47-991e-8e59ecdfaf45","description":""},{"name":"User Management","item":[{"name":"Attorney","item":[{"name":"Exp Edu","item":[{"name":"Create Education Experience","id":"555ba1a8-0688-471a-bb77-adb6a6493e1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"education\": {\n \"institution\": \"Yale University\",\n \"degree\": \"Bachelor of Arts in Political Science\",\n \"year\": 2011\n },\n \"experience\": {\n \"organization\": \"XYZ Legal Services\",\n \"title\": \"Junior Attorney\",\n \"years\": 2\n }\n }","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/attorney/educationandexperience","urlObject":{"path":["api","attorney","educationandexperience"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[]}},"response":[],"_postman_id":"555ba1a8-0688-471a-bb77-adb6a6493e1e"},{"name":"Update Attorney Experience and Education","id":"74502cdf-9b32-4a3f-a97a-f083b9f562c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"experience\":{\n \"institution\": \"Harvard Law School\",\n \"degree\": \"Juris Law\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/attorney/educationandexperience/:education_experienceid","urlObject":{"path":["api","attorney","educationandexperience",":education_experienceid"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[{"type":"any","value":"{{education_experienceid}}","key":"education_experienceid"}]}},"response":[],"_postman_id":"74502cdf-9b32-4a3f-a97a-f083b9f562c0"},{"name":"Delete Attorney Experience and Education","id":"7ab067bc-665e-409c-8cf5-ec7eddd9a89f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"http://127.0.0.1:8000/api/attorney/educationandexperience/:education_experienceid","urlObject":{"path":["api","attorney","educationandexperience",":education_experienceid"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[{"type":"any","value":"{{education_experienceid}}","key":"education_experienceid"}]}},"response":[],"_postman_id":"7ab067bc-665e-409c-8cf5-ec7eddd9a89f"},{"name":"Get Attorney Experience and Education","event":[{"listen":"test","script":{"id":"3144a82f-ab58-49c9-8057-d17953c6cd64","exec":["// Parse the response body","let response = pm.response.json();","","// Initialize variable to hold the ID","let id = null;","","// Check if education exists and has at least one item","if (response.data && response.data.education && response.data.education.length > 0) {"," id = response.data.education[0].id;","} else if (response.data && response.data.experience && response.data.experience.length > 0) {"," id = response.data.experience[0].id;","}","","// Set the global variable only if an ID is found","if (id) {"," pm.globals.set(\"education_experienceid\", id);"," console.log(\"education_experienceid set to:\", id);","} else {"," console.log(\"No education or experience found. Global variable remains unchanged.\");","}"],"type":"text/javascript","packages":{}}}],"id":"3629af97-f3d8-4f26-8462-e1efc9dc2918","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"http://127.0.0.1:8000/api/attorney/educationandexperience/:attorneyid","urlObject":{"path":["api","attorney","educationandexperience",":attorneyid"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[{"type":"any","value":"{{attorneyid}}","key":"attorneyid"}]}},"response":[],"_postman_id":"3629af97-f3d8-4f26-8462-e1efc9dc2918"}],"id":"63bf6eb2-a232-4cd4-b336-ae0b27382d27","_postman_id":"63bf6eb2-a232-4cd4-b336-ae0b27382d27","description":""},{"name":"Upload License","id":"3db380d6-df6d-4914-ac5e-0e6156798674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"license_document","type":"file","uuid":"79299656-415c-4bf2-be28-92ff9af0aaae","src":"postman-cloud:///1f033cc6-9ff4-4f50-91d0-37dbea006074"}]},"url":"http://127.0.0.1:8000/api/attorney/uploadlicense","description":"{\n \"status_code\": 200,\n \"success\": true,\n \"message\": \"License document uploaded successfully\",\n \"data\": {\n \"license_url\": \"https://res.cloudinary.com/your-cloud-name/attorney_licenses/your-file-id\"\n }\n}\n{\n \"status_code\": 400,\n \"success\": false,\n \"message\": \"No file provided\"\n}\n{\n \"status_code\": 403,\n \"success\": false,\n \"message\": \"Only attorneys can upload license documents\"\n}\n{\n \"status_code\": 404,\n \"success\": false,\n \"message\": \"Attorney profile not found\"\n}\n{\n \"status_code\": 500,\n \"success\": false,\n \"message\": \"Failed to upload license document: [error details]\"\n}\n{\n \"info\": {\n \"name\": \"Legal Platform API\",\n \"schema\": \"https://schema.getpostman.com/json/collection/v2.1.0/collection.json\"\n },\n \"item\": [\n {\n \"name\": \"Attorney License Upload\",\n \"request\": {\n \"method\": \"POST\",\n \"header\": [\n {\n \"key\": \"Authorization\",\n \"value\": \"Bearer your_access_token_here\",\n \"type\": \"text\"\n }\n ],\n \"body\": {\n \"mode\": \"formdata\",\n \"formdata\": [\n {\n \"key\": \"license_document\",\n \"type\": \"file\",\n \"src\": \"/path/to/your/license.pdf\"\n }\n ]\n },\n \"url\": {\n \"raw\": \"http://127.0.0.1:8000/api/attorney/upload-license/\",\n \"host\": [\"http://127.0.0.1:8000\"],\n \"path\": [\"api\", \"attorney\", \"upload-license\", \"\"]\n },\n \"description\": \"Upload attorney license document to Cloudinary and save URL to database\"\n },\n \"response\": []\n }\n ],\n \"variable\": [\n {\n \"key\": \"base_url\",\n \"value\": \"http://your-api-domain.com\"\n },\n {\n \"key\": \"access_token\",\n \"value\": \"your-jwt-token-here\"\n }\n ]\n}\nSetup Environment Variables
\nbase_url to your API domainaccess_token to a valid JWT token for an attorney accountTest Cases
\nFile Requirements
\nCreate a new user (client or attorney)
\nExample Request Body:
\n{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"password\": \"your_password\",\n \"confirm_password\": \"your_password\",\n \"role\": \"client\" // or \"attorney\"\n}\nCreate a new admin user (requires admin privileges)
\nExample Request Body:
\n{\n \"first_name\": \"Admin\",\n \"last_name\": \"User\",\n \"email\": \"admin@example.com\",\n \"password\": \"admin_password\",\n \"confirm_password\": \"admin_password\"\n}\nGet list of users (requires admin privileges)
\nQuery Parameters:
\nGet details of a specific user
\n","urlObject":{"path":["api","getuserbyid",":id"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[{"description":{"content":"User's UUID
\n","type":"text/plain"},"type":"any","value":"{{userid}}","key":"id"}]}},"response":[],"_postman_id":"2ba3f0e8-904b-4b95-b4d0-a6412f6f8ef7"},{"name":"Update User","id":"509f3106-d6ba-46f4-ae9a-bf102297f40e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer your_access_token_here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"expertise\": [\"Immigration Law\", \"Employment Law\"]\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/getuserbyid/:id","description":"Update user details (only owner or admin can update)
\nExample Request Body:
\n{\n \"first_name\": \"Updated\",\n \"last_name\": \"Name\",\n \"image\": \"new_image_url\"\n}\n\nUser's UUID
\n","type":"text/plain"},"type":"any","value":"{{userid}}","key":"id"}]}},"response":[],"_postman_id":"509f3106-d6ba-46f4-ae9a-bf102297f40e"},{"name":"Delete User","id":"eddbc0d0-0f0d-4275-a743-5d5f0c623eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer your_access_token_here"}],"url":"http://127.0.0.1:8000/api/getuserbyid/:id","description":"Delete a user (only owner or admin can delete)
\n","urlObject":{"path":["api","getuserbyid",":id"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[{"description":{"content":"User's UUID
\n","type":"text/plain"},"type":"any","value":"user_uuid_here","key":"id"}]}},"response":[],"_postman_id":"eddbc0d0-0f0d-4275-a743-5d5f0c623eeb"},{"name":"Update Profile Picture","id":"76afd227-0451-4776-90b6-44b31b23356e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","uuid":"abcf8786-1e1e-484e-8ed7-f870970dd723","src":"postman-cloud:///1f033e79-9ab2-4ec0-ab0e-94bdb91b87cc"}]},"url":"http://127.0.0.1:8000/api/user/uploadimage","urlObject":{"path":["api","user","uploadimage"],"host":["http://127.0.0.1:8000"],"query":[],"variable":[]}},"response":[],"_postman_id":"76afd227-0451-4776-90b6-44b31b23356e"}],"id":"59ade536-f61a-4c45-b03e-d5b4cdc2b909","_postman_id":"59ade536-f61a-4c45-b03e-d5b4cdc2b909","description":""},{"name":"OTP Management","item":[{"name":"Verify OTP","id":"d10dc29d-8245-4320-88df-de6e0cc5b710","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"user@example.com\",\n \"otp\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/verifyotp","description":"Verify OTP sent to user's email
\nExample Request Body:
\n{\n \"email\": \"user@example.com\",\n \"otp\": \"123456\"\n}\nRequest a new OTP to be sent to user's email
\nExample Request Body:
\n{\n \"email\": \"user@example.com\"\n}\nThis endpoint retrieves details of a specific case identified by the caseid.
No request body is required for this endpoint.
\ncaseid (path parameter) : The unique identifier of the case.The response will be a JSON object with the following schema:
\n{\n \"success\": boolean,\n \"message\": string,\n \"data\": {\n \"id\": string,\n \"title\": string,\n \"description\": string,\n \"document\": string,\n \"is_probono\": boolean,\n \"is_available\": boolean,\n \"created_at\": string,\n \"updated_at\": string\n },\n \"error\": array,\n \"statuscode\": number\n}\n\nsuccess : Indicates if the request was successful.
message : A message related to the response.
data : An object containing the details of the case.
id : The unique identifier of the case.
title : The title of the case.
description : The description of the case.
document : The document related to the case.
is_probono : Indicates if the case is pro bono.
is_available : Indicates if the case is available.
created_at : The timestamp when the case was created.
updated_at : The timestamp when the case was last updated.
error : An array of error messages, if any.
statuscode : The status code of the response.