API Overview
The HeadshotPro API: what it automates, the three ways to connect your HR tools, and where the full documentation lives.
API Overview
The HeadshotPro API gives admins programmatic control over the team workflow. Invite members, manage teams, track progress and pull finished photos without the dashboard. It is included with every team account.
There are three ways to connect HeadshotPro to an HR system such as Workday, BambooHR or your own directory:
| Method | Best for |
|---|---|
| API | Your own integration: invite new hires on day one, pull headshots into a directory, sync teams. |
| Zapier | No-code automation with 5,000+ apps: new member in your HRIS triggers an invite, finished headshot posts to Slack or a spreadsheet. |
| Custom integration | A larger rollout with specific needs. Contact sales@headshotpro.com. |
For endpoint documentation, authentication and code examples, see the API Documentation.
What you can do
| Resource | What it does |
|---|---|
| Organization | Read organization details and credit balance |
| Invites | Send, list and revoke member invitations |
| Team members | List members by completion status |
| Teams | Create, rename and delete teams; assign members |
| Models | List and inspect headshot sessions |
| Photos | Retrieve generated photos and favorites |
How it works
- Open API in the left menu and generate an API key.
- Send the key in the
Authorization: Bearer <key>header on every request. - Send invites, track progress and pull finished headshots.
- Connect Zapier from the same page, or set up webhooks to be notified instead of polling. See Webhooks and Integrations.
Good to know
- API access is available to the owner and admins.
- API keys are organization-wide. One key covers every team and member.
- Single sign-on (SAML 2.0 with Okta, Entra ID, Google and other providers) and SCIM directory sync are enterprise add-ons. Contact sales@headshotpro.com. See SSO Setup.
- Full reference docs with request and response examples are at headshotpro.com/api.
Related
Was this article helpful?