Your guide to our API
API Documentation
Explore the available endpoints and learn how to interact with our API. Our API allows you to programmatically manage your profile, skills, projects, experiences, education, social links, and "About Me" section.
Profile
Manage your public profile information, including retrieving user details, updating your profile, and managing your avatar image.
GET /api/v1/profile/{username}
PATCH /api/v1/profile
PATCH /api/v1/profile/avatar
DELETE /api/v1/profile/avatar
Skills
Add, view, and remove skills associated with your profile to showcase your expertise.
GET /api/v1/profile/{username}/skills
POST /api/v1/skills
DELETE /api/v1/skills/{skill}
Projects
Manage your portfolio of projects by adding new entries, viewing existing ones, and deleting completed or outdated projects.
GET /api/v1/profile/{username}/projects
POST /api/v1/projects
DELETE /api/v1/projects/{project}
Experiences
Document your professional experiences, including job titles, companies, and dates, with options to add, view, and remove entries.
GET /api/v1/profile/{username}/experiences
POST /api/v1/experiences
DELETE /api/v1/experiences/{experience}
Education
Record your academic history, including degrees, institutions, and dates. You can add, view, and remove your educational achievements.
GET /api/v1/profile/{username}/education
POST /api/v1/education
DELETE /api/v1/education/{education}
About Me
Update the "About Me" section of your profile, providing a detailed description of yourself or your work.
GET /api/v1/profile/{username}/about-me
PATCH /api/v1/about-me
Socials
Update and manage your social media links and other external profiles that you wish to display on your profile.
GET /api/v1/profile/{username}/socialsPATCH /api/v1/socials