API Documentation (WIP)

API Reference

Authentication

HeadshotPro uses API keys to allow access to the API.

All API requests on HeadshotPro are scoped to an Organization. A unique API key can be generated by Team Owners at www.headshotpro.com/app/admin/api.

HeadshotPro expects the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer API_KEY

All request bodies need to be valid JSON

---

API Endpoints

All HeadshotPro endpoints start with https://server.headshotpro.com/api/v1/

We're working hard on adding new endpoints. Reach out to our support to make a request.

Current available endpoints:

Invite a team member

POST: https://server.headshotpro.com/api/v1/organization/invite

BODY:{ email: USER_EMAIL}

(Credits are only consumed when a a team member uploads their photos)

Revoke an invite

POST: https://server.headshotpro.com/api/v1/organization/invite/revoke

BODY:{ email: USER_EMAIL}