LinkedIn Audit API

Base URL: https://server.feedboss.ai/api/v1/linkedin-profile

Authentication

All endpoints require authentication. You can authenticate using a Service API Key.

Service API Key

Add your Service API Key to the x-api-key header.

x-api-key: fb_live_xxxxxxxxxxxxxxxxxxxxxxxx

---

Endpoints

1. Analyze Profile

Performs a comprehensive audit of a LinkedIn profile using AI and data from LinkedIn.

• Endpoint: POST /:workspaceId/analyze
• Description: Triggers a real-time analysis of the specified LinkedIn profile. Requires a valid workspace subscription and API key quota.

Path Parameters:

Parameter	Type	Required	Description
workspaceId	string	Yes	The ID of the workspace.

Request Body:

{
  "username": "williamhgates" 
}

Parameter	Type	Required	Description
username	string	Yes	The public LinkedIn username (identifier from the profile URL).

Success Response (200 OK):

{
  "success": true,
  "data": {
    "_id": "65b8f...",
    "user": "65a12...",
    "workspace": "65a12...",
    "username": "williamhgates",
    "profileUrl": "https://linkedin.com/in/williamhgates",
    "overallScore": 85,
    "brandScore": 90,
    "contentPillar": "Tech Leadership & Philanthropy",
    "sectionScores": {
      "coreHealth": 88,
      "seo": 80,
      "content": 90,
      "industryAuthority": 95
    },
    "analysis": {
      "headline": {
        "score": 90,
        "feedback": "Strong title but could use more keywords.",
        "suggestions": ["Add 'Co-chair' to headline"]
      },
      "about": {
        "score": 85,
        "feedback": "Compelling story but lengthy.",
        "suggestions": ["Break into paragraphs"]
      },
      "experience": { "score": 95, "feedback": "...", "suggestions": [] },
      "skills": { "score": 80, "feedback": "...", "suggestions": [] },
      "images": {
        "headshot": {
          "score": 95,
          "feedback": "Excellent professional headshot.",
          "provider": "openai"
        }
      }
    },
    "actionItems": [
      {
        "category": "SEO",
        "priority": "HIGH",
        "text": "Add 'Philanthropy' to your skills section."
      }
    ],
    "createdAt": "2024-01-28T12:00:00.000Z",
    "updatedAt": "2024-01-28T12:00:00.000Z"
  }
}

Error Responses:

• 400 Bad Request: Missing username or API key issues.
• 403 Forbidden: Subscription limits reached or invalid permissions.
• 404 Not Found: Profile not found.
• 500 Internal Server Error: Analysis failed.

2. Get Latest Analysis

Retrieves the most recent profile analysis for a specific workspace.

• Endpoint: GET /:workspaceId/latest

Path Parameters:

Parameter	Type	Required	Description
workspaceId	string	Yes	The ID of the workspace.

Success Response (200 OK):

{
  "success": true,
  "data": {
    "_id": "65b8f...",
    // ... same object structure as Analyze Profile response
  }
}

Returns data: null if no analysis exists.

3. Get Analysis by ID

Retrieves a specific profile analysis record by its ID.

• Endpoint: GET /:workspaceId/:id

Path Parameters:

Parameter	Type	Required	Description
workspaceId	string	Yes	The ID of the workspace (used for routing context).
id	string	Yes	The ID of the analysis record.

Success Response (200 OK):

{
  "success": true,
  "data": {
    "_id": "65b8f...",
    // ... same object structure as Analyze Profile response
  }
}

Error Responses:

• 404 Not Found: Analysis ID does not exist.