The Earnily API allows users to manage authentication, job listings, and job applications. This document provides an in-depth look into the various endpoints available within the API and their usage.
\nhttps://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net\n\nNo authentication is required for registration and login endpoints. Bearer token authentication is used for all other protected endpoints.
\nAfter successful login, a JWT token is returned, which must be passed in the Authorization header for subsequent requests:
\nAuthorization: Bearer <token>\n\nThis endpoint enables user registration by submitting the following details: first name, last name, role, email, and password.
\nUsers can register as either jobseekers or employers by specifying the appropriate value in the role parameter.
\nImportant Note:
After registration, an OTP (One-Time Password) will be sent to the user's email. The user must verify their email ownership using the Verify Email endpoint.
This API endpoint allows users to log in by providing their email and password.
\nThis endpoint verifies a user, using the otp sent to the user's email
\nNote: Entering of wrong otp five(5) times might lead to your account being blocked
\nThis endpoint is used to request for new email verification token
\n","urlObject":{"path":["api","v1","auth","resend-otp"],"host":["https://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"6ba9ead4-b548-4c28-aebc-32f31ec00cdf","name":"Resend Email Verification OTP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"ezeisraeljohn@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://c0c4-197-210-78-216.ngrok-free.app/api/v1/auth/resend-otp"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"76"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 31 Dec 2024 13:23:11 GMT"},{"key":"Etag","value":"W/\"4c-SQdL/m4O4hmL+BqzVrsCEKcaGVM\""},{"key":"Ngrok-Agent-Ips","value":"197.210.84.245"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Ratelimit-Limit","value":"50000"},{"key":"X-Ratelimit-Remaining","value":"49991"},{"key":"X-Ratelimit-Reset","value":"1735651833"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"status\": 400,\n \"message\": \"User already verified\",\n \"data\": null\n}"}],"_postman_id":"61a0c2eb-97b6-4307-be1a-c081a14d8ff9"},{"name":"Request Password Reset OTP","id":"f87d8c92-4f78-4395-8284-130032621801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows you to create a new job posting.
\nRequest Body
\ntitle (text, required): The title of the job.
\ndescription (text, required): Description of the job.
\nlocation (text, required): Location of the job.
\nsalaryMin (number, required): Minimum salary for the job.
\nsalaryMax (number, required): Maximum salary for the job.
\ncompany (text, required): Name of the company.
\njobType (text, required): Type of job (e.g. full-time, part-time).
\nResponse
\nsuccess (boolean): Indicates if the request was successful.
\nstatus (number): Status code of the response.
\nmessage (text): Additional message related to the response.
\ndata (object): Object containing details of the created job, including title, company, location, salary range, description, job type, posted by, date posted, and ID.
\nThis endpoint retrieves the jobs associated with the authenticated user.
\nRequest Body:
This request does not require a request body.
Response:
The response will be a JSON object with the following structure:
success (boolean): Indicates whether the request was successful.
status (integer): Represents the status of the request.
data (array): Contains the list of jobs with the following attributes:
_id (string): The unique identifier for the job.
title (string): The title of the job.
company (string): The company offering the job.
location (string): The location of the job.
salaryMin (integer): The minimum salary for the job.
salaryMax (integer): The maximum salary for the job.
description (string): A brief description of the job.
jobType (string): The type of job (e.g., full-time, part-time).
postedBy (string): The user who posted the job.
datePosted (string): The date when the job was posted.
__v (integer): Version key for the job data.
This endpoint is used to delete a specific job by its ID.
\nMethod: DELETE
\nEndpoint: https://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net/api/v1/jobs/:id
The response for this request is a JSON schema. It includes the following properties:
\nmessage: A string indicating the outcome of the delete operation.This endpoint allows the client to update the details of a specific job.
\ntitle (string, required): The title of the job.
\ndescription (string, required): A brief description of the job.
\nlocation (string, required): The location of the job.
\nsalary (number, required): The salary offered for the job.
\ncompany (string, required): The name of the company offering the job.
\njobType (string, required): The type of job (e.g., internship, full-time).
\nThis endpoint retrieves the details of a specific job by providing the job ID in the URL.
\nMethod: GET
\nURL: https://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net/api/v1/job/:id
\nStatus: 200
\nContent-Type: application/json
\nsuccess (boolean): Indicates if the request was successful.
\nstatus (integer): Represents the status of the response.
\ndata (object):
\ntitle (string): The title of the job.
\ncompany (string): The name of the company offering the job.
\nlocation (string): The location of the job.
\nsalaryMin (integer): The minimum salary offered for the job.
\nsalaryMax (integer): The maximum salary offered for the job.
\ndescription (string): Description of the job.
\njobType (string): Type of the job.
\npostedBy (string): Name of the user who posted the job.
\ndatePosted (string): Date when the job was posted.
\nid (string): Unique identifier of the job.
\nThis endpoint allows you to apply for a job by submitting your resume, cover letter, and the job ID.
\nRequest Body
\nresume (file): The resume file to be uploaded.
jobId (text): The ID of the job you are applying for.
coverLetter (text): Your cover letter for the job application.
Response
\nsuccess (boolean): Indicates whether the request was successful.
status (integer): The status of the application.
data (object): Contains details of the job application, including the job ID, applicant details, resume, cover letter, status, and application date.
job (string): The ID of the job applied for.
applicant (string): The ID of the applicant.
resume (string): The URL of the uploaded resume.
coverLetter (string): The cover letter submitted.
status (string): The status of the application.
_id (string): The unique ID of the application.
dateApplied (string): The date and time of the application.
__v (integer): Version control field.
This endpoint retrieves a list of applications for a specific job ID. The request does not require any request body parameters.
\nThe response will include a JSON object with the following fields:
\nsuccess (boolean): Indicates if the request was successful.
\nstatus (integer): Represents the status of the request.
\ndata (array): Contains a list of application objects, each including the following fields:
\n_id (string): Unique identifier for the application.
\njob (string): ID of the job the application is for.
\napplicant (object): Details of the applicant including their ID, first name, last name, and email.
\nresume (string): URL or reference to the applicant's resume.
\ncoverLetter (string): URL or reference to the applicant's cover letter.
\nstatus (string): Current status of the application.
\ndateApplied (string): Date when the application was submitted.
\n__v (integer): Version of the application data.
\nThis endpoint retrieves a list of applications.
\nMethod: GET
\nURL: https://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net/api/v1/applications
\nThe response will include the following fields:
\nsuccess (boolean): Indicates if the request was successful.
\nstatus (integer): Represents the status of the response.
\ncount (integer): The number of applications returned.
\ndata (array): An array of application objects, each containing the following fields:
\n_id (string): The unique identifier for the application.
\njob (object): Details of the job applied for, including _id, title, company, location, and jobType.
\napplicant (string): The applicant's information.
\nresume (string): The resume submitted with the application.
\ncoverLetter (string): The cover letter submitted with the application.
\nstatus (string): The status of the application.
\ndateApplied (string): The date when the application was submitted.
\n__v (integer): Version control field.
\nExample Response:
\n{\n \"success\": true,\n \"status\": 0,\n \"count\": 0,\n \"data\": [\n {\n \"_id\": \"\",\n \"job\": {\n \"_id\": \"\",\n \"title\": \"\",\n \"company\": \"\",\n \"location\": \"\",\n \"jobType\": \"\"\n },\n \"applicant\": \"\",\n \"resume\": \"\",\n \"coverLetter\": \"\",\n \"status\": \"\",\n \"dateApplied\": \"\",\n \"__v\": 0\n }\n ]\n}\n\nThis endpoint allows the client to update the status of a specific application.
\nMethod: PUT
\nURL: https://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net/api/v1/applications/:id
\n{ \"status\": \"reviewing\"}
\nThe firstName of the Individual
\n","type":"text"},{"key":"lastName","value":"Eze","description":"The lastName of the individual
\n","type":"text"},{"key":"skills","value":"6770a4adf19030f08f06414b,6770a4adf19030f08f06414c,6770a2bc867d71cc1e82be20","description":"The Skills of the user
\n","type":"text"},{"key":"profilePicture","description":"The profile picture of the user
\n","type":"file","value":null},{"key":"categories","value":"6770a2bc867d71cc1e82be1b","type":"text"}]},"url":"https://earnily-d7abhjd5apcpfzah.canadacentral-01.azurewebsites.net/api/v1/user/:userId","description":"