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.

Retrieve Specific: GET /api/v1/profile/{username}
Update Existing: PATCH /api/v1/profile
Update Avatar Image: PATCH /api/v1/profile/avatar
Delete Avatar Image: DELETE /api/v1/profile/avatar

Skills

Add, view, and remove skills associated with your profile to showcase your expertise.

Retrieve All: GET /api/v1/profile/{username}/skills
Create New: POST /api/v1/skills
Delete: DELETE /api/v1/skills/{skill}

Projects

Manage your portfolio of projects by adding new entries, viewing existing ones, and deleting completed or outdated projects.

Retrieve All: GET /api/v1/profile/{username}/projects
Create New: POST /api/v1/projects
Delete: DELETE /api/v1/projects/{project}

Experiences

Document your professional experiences, including job titles, companies, and dates, with options to add, view, and remove entries.

Retrieve All: GET /api/v1/profile/{username}/experiences
Create New: POST /api/v1/experiences
Delete: DELETE /api/v1/experiences/{experience}

Education

Record your academic history, including degrees, institutions, and dates. You can add, view, and remove your educational achievements.

Retrieve All: GET /api/v1/profile/{username}/education
Create New: POST /api/v1/education
Delete: DELETE /api/v1/education/{education}

Socials

Update and manage your social media links and other external profiles that you wish to display on your profile.

Retrieve All: GET /api/v1/profile/{username}/socials
Update Existing: PATCH /api/v1/socials

About Me

Update the "About Me" section of your profile, providing a detailed description of yourself or your work.

Retrieve All: GET /api/v1/profile/{username}/about-me
Update Existing: PATCH /api/v1/about-me