API Overview
A summary of the HeadshotPro API — what it does, what you can automate, and where to find the full documentation.
API Overview
The HeadshotPro API gives team admins programmatic control over their organization's headshot workflow. You can invite members, manage teams, track progress, and retrieve generated photos without touching the dashboard.
For full endpoint documentation, authentication details, and code examples, see the API Documentation.
What you can do
| Resource | What it does |
|---|---|
| Organization | Read org details and credit balance |
| Invites | Send, list, and revoke member invitations |
| Team Members | List members by completion status |
| Teams | Create, rename, delete teams; assign members |
| Models | List and inspect AI headshot sessions |
| Photos | Retrieve generated photos and favorites |
How it works
- Go to Admin Dashboard > API and generate an API key.
- Use the key in the
Authorization: Bearer <key>header on every request. - Send invites, track progress, and pull finished headshots through the API.
- Optionally configure webhooks to get notified in real time instead of polling.
Good to know
- API access is available to Team Owners and Admins.
- API keys are organization-scoped — one key covers all teams and members.
- Full reference docs with request/response examples are at headshotpro.com/api.
Related
Was this article helpful?