v1.2.0 Stable

API Reference

Integrate with the Professional Portfolio platform programmatically. Manage projects, testimonials, portfolio assets, and client inquiries through our RESTful JSON API.

Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header for every request.

Header
Authorization: Bearer <YOUR_API_KEY>

Keys can be generated from your dashboard settings. We recommend using environment variables to store keys securely.

Base URL

All API requests are made to the following endpoint:

Base URL
https://api.professionalportfolio.dev/v1/

Projects

Manage your featured projects and case studies.

GET /projects
Retrieve a paginated list of all published projects.
Query Parameters
ParameterTypeDescription
limit (optional)integerNumber of results per page (1-100)
offset (optional)integerPagination offset
category (optional)stringFilter by project category
Response 200 OK
JSON
{
  "success": true,
  "data": [
    {
      "id": "proj_123",
      "title": "LuxeCart E-Commerce",
      "status": "published"
    }
  ],
  "pagination": {
    "total": 42
  }
}
GET /projects/:id
Get detailed information about a specific project by its ID.
Path Parameters
ParameterTypeDescription
id (required)stringThe unique project identifier
POST /projects
Create a new project entry in your portfolio.
Request Body
FieldTypeDescription
title (required)stringProject title
description (optional)stringShort overview
tags (optional)arrayList of technology tags

Testimonials

Access and manage client feedback and reviews.

GET /testimonials
List all approved client testimonials.

Error Handling

The API uses standard HTTP status codes. Errors return a consistent JSON structure.

Error Response
{
  "success": false,
  "error": {
    "code": "AUTH_FAILED",
    "message": "Invalid or expired API key",
    "details": null
  }
}

SDKs & Libraries

Official and community-maintained libraries for quick integration.

npm
npm install @professional-portfolio/sdk
Copied to clipboard!