HeadshotPro / API Docs
API Key

HeadshotPro API

Welcome to the HeadshotPro API documentation. Our API allows you to programmatically manage your organization's AI headshot generation workflow.

What you can do

  • Invite team members - Send invitations and track their progress
  • Manage teams - Create and organize teams within your organization
  • Access headshots - Retrieve generated photos and favorites
  • Monitor credits - Track your organization's credit balance
  • Whitelabel integration - Embed HeadshotPro into your own application

Quick Start

1. Get your API key

Generate an API key from your organization settings.

2. Make your first request

curl -X GET "https://server.headshotpro.com/api/v2/organization" \
  -H "Authorization: Bearer YOUR_API_KEY"

3. Invite a team member

curl -X POST "https://server.headshotpro.com/api/v2/organization/invites" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

Base URL

All API requests should be made to:

https://server.headshotpro.com/api/v2

API Versions

VersionStatusBase URL
V2Current/api/v2/organization/...
V1Legacy/api/v1/organization/...

We recommend using V2 for all new integrations. V1 endpoints remain available for backwards compatibility.

Response Format

All responses are JSON with a consistent structure:

Success Response

{
  "success": true,
  "data": { ... }
}

Error Response

{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE"
}

Need Help?