API Reference
Public Data
Public Data Endpoints
7 read-only endpoints. No authentication required. Access any user's public profile data.
Base URL
Public API
7Get a user's public profile
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| id | uuid |
Yes | User ID* |
| username | string |
Yes | Username* |
| full_name | string |
Yes | Display name* |
| bio | string? |
No | Bio text |
| location | string? |
No | Location |
| website | string? |
No | Website URL |
| github_url | string? |
No | GitHub profile |
| linkedin_url | string? |
No | LinkedIn profile |
| open_to_work | boolean? |
No | Explicit availability state when the owner has set it |
Response 200 OK
{
"id": "a1b2c3d4-5678-9abc-def0-123456789abc",
"username": "hershel",
"full_name": "Hershel Moshkovitz",
"bio": "Full-stack engineer passionate about building elegant APIs.",
"location": "Herzliya, Israel",
"website": "https://hershel.dev",
"github_url": "https://github.com/hershel",
"linkedin_url": "https://linkedin.com/in/hershel",
"open_to_work": true
}
Get a user's skills
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| [ ] | array |
Yes | Array of SkillResponse (name, category, proficiency, years_of_experience)* |
Response 200 OK
[
{
"id": "c3d4e5f6-789a-bcde-f012-3456789abcde",
"name": "Python",
"category": "Languages",
"proficiency": "expert",
"years_of_experience": 5
},
{
"id": "d4e5f678-9abc-def0-1234-56789abcdef0",
"name": "FastAPI",
"category": "Frameworks",
"proficiency": "advanced",
"years_of_experience": 3
}
]
Get work experience history
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| [ ] | array |
Yes | Array of ExperienceResponse (company, title, dates, technologies)* |
Response 200 OK
[
{
"id": "e5f67890-abcd-ef01-2345-6789abcdef01",
"company": "RESTume Inc.",
"title": "Senior Backend Engineer",
"location": "Herzliya, Israel",
"start_date": "2024-01-15",
"end_date": null,
"is_current": true,
"description": "Building the next-gen AI resume platform.",
"technologies": "Python, FastAPI, ChromaDB, Docker"
}
]
Get education history
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| [ ] | array |
Yes | Array of EducationResponse (institution, degree, field_of_study, gpa)* |
Response 200 OK
[
{
"id": "f6789012-bcde-f012-3456-789abcdef012",
"institution": "IDC Herzliya",
"degree": "B.Sc.",
"field_of_study": "Computer Science",
"start_date": "2022-10-01",
"end_date": "2025-06-30",
"gpa": 3.7,
"is_current": false,
"description": "Specialization in AI and distributed systems."
}
]
Get portfolio projects
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| [ ] | array |
Yes | Array of ProjectResponse (name, description, technologies, urls)* |
Response 200 OK
[
{
"id": "01234567-89ab-cdef-0123-456789abcdef",
"name": "RESTume",
"description": "SaaS platform that turns resumes into live APIs with AI chat.",
"technologies": "Python, FastAPI, ChromaDB, HTMX, Tailwind CSS",
"url": "https://restume.com",
"repository_url": "https://github.com/HershelT/RESTume",
"is_featured": true
}
]
Get certifications
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| [ ] | array |
Yes | Array of CertificationResponse (name, issuer, issue_date, credential_url)* |
Response 200 OK
[
{
"id": "89abcdef-0123-4567-89ab-cdef01234567",
"name": "AWS Certified Developer",
"issuer": "Amazon Web Services",
"issue_date": "2025-01-01",
"expiration_date": "2028-01-01",
"credential_id": "ABC-12345",
"credential_url": "https://example.com/cert/aws-dev",
"description": "Professional developer certification."
}
]
Get full structured JSON resume
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| username | string |
Yes | Target username* |
Response
| Field | Type | Required | Description |
|---|---|---|---|
| profile | UserPublic |
Yes | Profile data* |
| skills | array |
Yes | All skills* |
| experience | array |
Yes | All experience* |
| education | array |
Yes | All education* |
| projects | array |
Yes | All projects* |
| certifications | array |
Yes | All certifications* |
Response 200 OK
{
"profile": {
"username": "hershel",
"full_name": "Hershel Moshkovitz",
"bio": "Full-stack engineer passionate about building elegant APIs.",
"location": "Herzliya, Israel",
"open_to_work": true
},
"skills": [
{"name": "Python", "category": "Languages", "proficiency": "expert"}
],
"experience": [
{"company": "RESTume Inc.", "title": "Senior Backend Engineer", "is_current": true}
],
"education": [
{"institution": "IDC Herzliya", "degree": "B.Sc.", "field_of_study": "Computer Science"}
],
"projects": [
{"name": "RESTume", "description": "Live resume API platform", "is_featured": true}
],
"certifications": [
{"name": "AWS Certified Developer", "issuer": "Amazon Web Services"}
]
}