[{"data":1,"prerenderedAt":442},["ShallowReactive",2],{"docs-team-lead\u002Fintegrations\u002Fapi-overview":3},{"article":4,"sectionArticles":253,"categories":419,"relatedArticles":440,"prevArticle":299,"nextArticle":306,"categoryName":430,"error":441},{"id":5,"title":6,"avatar":7,"body":8,"description":245,"docx":7,"extension":246,"meta":247,"navigation":248,"order":7,"path":249,"pdf":7,"pdfLabel":7,"procurementPack":7,"seo":250,"slug":7,"stem":251,"__hash__":252},"content\u002Fdocs\u002Fteam-lead\u002Fintegrations\u002Fapi-overview.md","API Overview",null,{"type":9,"value":10,"toc":237},"minimark",[11,15,19,22,79,88,93,155,159,187,191,217,221],[12,13,6],"h1",{"id":14},"api-overview",[16,17,18],"p",{},"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.",[16,20,21],{},"There are three ways to connect HeadshotPro to an HR system such as Workday, BambooHR or your own directory:",[23,24,25,38],"table",{},[26,27,28],"thead",{},[29,30,31,35],"tr",{},[32,33,34],"th",{},"Method",[32,36,37],{},"Best for",[39,40,41,53,63],"tbody",{},[29,42,43,50],{},[44,45,46],"td",{},[47,48,49],"strong",{},"API",[44,51,52],{},"Your own integration: invite new hires on day one, pull headshots into a directory, sync teams.",[29,54,55,60],{},[44,56,57],{},[47,58,59],{},"Zapier",[44,61,62],{},"No-code automation with 5,000+ apps: new member in your HRIS triggers an invite, finished headshot posts to Slack or a spreadsheet.",[29,64,65,70],{},[44,66,67],{},[47,68,69],{},"Custom integration",[44,71,72,73,78],{},"A larger rollout with specific needs. Contact ",[74,75,77],"a",{"href":76},"mailto:sales@headshotpro.com","sales@headshotpro.com",".",[16,80,81,82,78],{},"For endpoint documentation, authentication and code examples, see the ",[74,83,87],{"href":84,"rel":85},"https:\u002F\u002Fwww.headshotpro.com\u002Fapi",[86],"nofollow","API Documentation",[89,90,92],"h2",{"id":91},"what-you-can-do","What you can do",[23,94,95,105],{},[26,96,97],{},[29,98,99,102],{},[32,100,101],{},"Resource",[32,103,104],{},"What it does",[39,106,107,115,123,131,139,147],{},[29,108,109,112],{},[44,110,111],{},"Organization",[44,113,114],{},"Read organization details and credit balance",[29,116,117,120],{},[44,118,119],{},"Invites",[44,121,122],{},"Send, list and revoke member invitations",[29,124,125,128],{},[44,126,127],{},"Team members",[44,129,130],{},"List members by completion status",[29,132,133,136],{},[44,134,135],{},"Teams",[44,137,138],{},"Create, rename and delete teams; assign members",[29,140,141,144],{},[44,142,143],{},"Models",[44,145,146],{},"List and inspect headshot sessions",[29,148,149,152],{},[44,150,151],{},"Photos",[44,153,154],{},"Retrieve generated photos and favorites",[89,156,158],{"id":157},"how-it-works","How it works",[160,161,162,169,177,180],"ol",{},[163,164,165,166,168],"li",{},"Open ",[47,167,49],{}," in the left menu and generate an API key.",[163,170,171,172,176],{},"Send the key in the ",[173,174,175],"code",{},"Authorization: Bearer \u003Ckey>"," header on every request.",[163,178,179],{},"Send invites, track progress and pull finished headshots.",[163,181,182,183,78],{},"Connect Zapier from the same page, or set up webhooks to be notified instead of polling. See ",[74,184,186],{"href":185},"\u002Fdocs\u002Fteam-lead\u002Fintegrations\u002Fwebhooks-and-integrations","Webhooks and Integrations",[89,188,190],{"id":189},"good-to-know","Good to know",[192,193,194,197,200,210],"ul",{},[163,195,196],{},"API access is available to the owner and admins.",[163,198,199],{},"API keys are organization-wide. One key covers every team and member.",[163,201,202,203,205,206,78],{},"Single sign-on (SAML 2.0 with Okta, Entra ID, Google and other providers) and SCIM directory sync are enterprise add-ons. Contact ",[74,204,77],{"href":76},". See ",[74,207,209],{"href":208},"\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fsso-setup","SSO Setup",[163,211,212,213,78],{},"Full reference docs with request and response examples are at ",[74,214,216],{"href":84,"rel":215},[86],"headshotpro.com\u002Fapi",[89,218,220],{"id":219},"related","Related",[192,222,223,227,231],{},[163,224,225],{},[74,226,186],{"href":185},[163,228,229],{},[74,230,209],{"href":208},[163,232,233],{},[74,234,236],{"href":235},"\u002Fdocs\u002Fteam-lead\u002Fgetting-started\u002Finviting-members","Inviting Members",{"title":238,"searchDepth":239,"depth":239,"links":240},"",2,[241,242,243,244],{"id":91,"depth":239,"text":92},{"id":157,"depth":239,"text":158},{"id":189,"depth":239,"text":190},{"id":219,"depth":239,"text":220},"The HeadshotPro API: what it automates, the three ways to connect your HR tools, and where the full documentation lives.","md",{},true,"\u002Fdocs\u002Fteam-lead\u002Fintegrations\u002Fapi-overview",{"title":6,"description":245},"docs\u002Fteam-lead\u002Fintegrations\u002Fapi-overview","j7E5Bi047IleBw95gqzSawHSZF65lgpZQVvTi1_ykrU",[254,260,265,270,275,281,284,289,294,299,304,306,311,314,320,325,330,335,340,345,350,355,360,363,369,374,379,384,389,394,399,404,409,414],{"title":255,"description":256,"path":257,"dir":258,"slug":259},"Billing History","Where to find invoices and receipts, add your company details to them, and read the credit activity log.","\u002Fdocs\u002Fteam-lead\u002Fbilling\u002Fbilling-history","\u002Fdocs\u002Fteam-lead\u002Fbilling","billing-history",{"title":261,"description":262,"path":263,"dir":258,"slug":264},"Credits Overview","How team credits work: when a credit is used, what happens when someone leaves, edit credits, and how to track usage.","\u002Fdocs\u002Fteam-lead\u002Fbilling\u002Fcredits-overview","credits-overview",{"title":266,"description":267,"path":268,"dir":258,"slug":269},"Purchasing Credits","How to buy credits for your team: payment methods, the volume discount ladder, invoices for large orders, and automatic top-up.","\u002Fdocs\u002Fteam-lead\u002Fbilling\u002Fpurchasing-credits","purchasing-credits",{"title":271,"description":272,"path":273,"dir":258,"slug":274},"Refunds for Teams","The 30-day money-back guarantee for team purchases and how to request a refund.","\u002Fdocs\u002Fteam-lead\u002Fbilling\u002Frefunds","refunds",{"title":276,"description":277,"path":278,"dir":279,"slug":280},"Creating a Team Account","How to set up a HeadshotPro team: answer four questions, pick the look, pay, and invite your team.","\u002Fdocs\u002Fteam-lead\u002Fgetting-started\u002Fcreating-a-team","\u002Fdocs\u002Fteam-lead\u002Fgetting-started","creating-a-team",{"title":236,"description":282,"path":235,"dir":279,"slug":283},"Three ways to add people to your team: email invites, your shareable team link, or uploading photos for them.","inviting-members",{"title":285,"description":286,"path":287,"dir":279,"slug":288},"The New AI Model for Teams","What changed with the latest AI model: 2–3 selfies instead of 15, 40 headshots per person, self-serve redos, and how to upgrade an older team.","\u002Fdocs\u002Fteam-lead\u002Fgetting-started\u002Fnew-model","new-model",{"title":290,"description":291,"path":292,"dir":279,"slug":293},"HeadshotPro for Teams: Overview","How HeadshotPro Teams works for organizations: one consistent look, self-serve shoots for every member, and answers to the questions buyers ask first.","\u002Fdocs\u002Fteam-lead\u002Fgetting-started\u002Foverview","overview",{"title":295,"description":296,"path":297,"dir":279,"slug":298},"Overview","Your team dashboard: credits, member progress, pending invites, the team link, and the left menu.","\u002Fdocs\u002Fteam-lead\u002Fgetting-started\u002Fteam-dashboard","team-dashboard",{"title":300,"description":301,"path":302,"dir":279,"slug":303},"Team Link, QR Code and Poster","Your team's permanent join link at headshotpro.com\u002Ft\u002Fyour-company, its QR code, and the printable poster.","\u002Fdocs\u002Fteam-lead\u002Fgetting-started\u002Fteam-link-qr-and-poster","team-link-qr-and-poster",{"title":6,"description":245,"path":249,"dir":305,"slug":14},"\u002Fdocs\u002Fteam-lead\u002Fintegrations",{"title":307,"description":308,"path":309,"dir":305,"slug":310},"Gift Codes","Hand out headshots with redeemable codes instead of a team invite.","\u002Fdocs\u002Fteam-lead\u002Fintegrations\u002Fgift-codes","gift-codes",{"title":186,"description":312,"path":185,"dir":305,"slug":313},"Connect HeadshotPro to Zapier or to your own systems with webhooks.","webhooks-and-integrations",{"title":315,"description":316,"path":317,"dir":318,"slug":319},"Creating and Managing Teams","How to create, edit, and delete sub-teams within your organization to group members by department","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fcreating-teams","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team","creating-teams",{"title":321,"description":322,"path":323,"dir":318,"slug":324},"Custom Fields","Collect extra information from your team members during their headshot onboarding.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fcustom-fields","custom-fields",{"title":326,"description":327,"path":328,"dir":318,"slug":329},"Customizing Emails","Control which emails your team receives, where admin alerts go, and rewrite the wording of member emails.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fcustomizing-emails","customizing-emails",{"title":331,"description":332,"path":333,"dir":318,"slug":334},"Deleting Your Organization","How the owner deletes a team organization, and how a team lead then deletes their own HeadshotPro account.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fdeleting-your-organization","deleting-your-organization",{"title":336,"description":337,"path":338,"dir":318,"slug":339},"Managing Members","Find any member, see where they are in their shoot, and take action from the Members page.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fmanaging-members","managing-members",{"title":341,"description":342,"path":343,"dir":318,"slug":344},"Organization Settings","Manage your organization's name, logo, headshot preferences and email notifications.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Forganization-settings","organization-settings",{"title":346,"description":347,"path":348,"dir":318,"slug":349},"Removing Members","Remove a member from your organization, and understand what happens to their data and your credits.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fremoving-members","removing-members",{"title":351,"description":352,"path":353,"dir":318,"slug":354},"Roles and Permissions","Understand the owner, admin and member roles, and how to add or remove admins.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Froles-and-permissions","roles-and-permissions",{"title":356,"description":357,"path":358,"dir":318,"slug":359},"Security Controls","Configure MFA for admins, manage admins, transfer ownership, and set data retention for your organization.","\u002Fdocs\u002Fteam-lead\u002Fmanaging-your-team\u002Fsecurity-controls","security-controls",{"title":209,"description":361,"path":208,"dir":318,"slug":362},"Connect your identity provider to HeadshotPro so team members authenticate through your company's existing SSO system.","sso-setup",{"title":364,"description":365,"path":366,"dir":367,"slug":368},"Approving and Managing Headshots","How to review finished member headshots, mark them as handled, and download photos for the whole team","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fapproving-and-managing-headshots","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots","approving-and-managing-headshots",{"title":370,"description":371,"path":372,"dir":367,"slug":373},"Bulk Uploading Photos","Upload ZIP files for multiple team members at once to create headshot models without individual onboarding.","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fbulk-uploading-photos","bulk-uploading-photos",{"title":375,"description":376,"path":377,"dir":367,"slug":378},"Creating Profile Picture Templates","How to create branded profile picture templates with shape, background, border, outline, and logo overlay settings.","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fcreating-templates","creating-templates",{"title":380,"description":381,"path":382,"dir":367,"slug":383},"Enforcing Consistency","Use the approved list, outfit rules, backdrop settings, per-team overrides and pose selection to keep every team headshot on-brand.","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fenforcing-consistency","enforcing-consistency",{"title":385,"description":386,"path":387,"dir":367,"slug":388},"Headshots Still Preparing","What to expect while a member's headshots generate, and what to do when a shoot looks stuck","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fheadshots-still-preparing","headshots-still-preparing",{"title":390,"description":391,"path":392,"dir":367,"slug":393},"Issuing Retries","How a team member gets a free retry, and how you start a new shoot for them when the retry is used up","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fissuing-retries","issuing-retries",{"title":395,"description":396,"path":397,"dir":367,"slug":398},"Managing Profile Picture Templates","How to edit, delete, set a default, and apply profile picture templates to organization members.","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fmanaging-templates","managing-templates",{"title":400,"description":401,"path":402,"dir":367,"slug":403},"Pose Selection","Restrict which body poses HeadshotPro cycles through when generating headshots for your team.","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fpose-selection","pose-selection",{"title":405,"description":406,"path":407,"dir":367,"slug":408},"Quality Tips","What to tell your team before they upload selfies, and why results sometimes differ from the person","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fquality-tips","quality-tips",{"title":410,"description":411,"path":412,"dir":367,"slug":413},"Style Presets","Choose the backdrops and outfits your team can use, add your own backdrops and outfits, and set a different look per team.","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fstyle-presets","style-presets",{"title":415,"description":416,"path":417,"dir":367,"slug":418},"Viewing Team Headshots","Track every member's shoot from Overview and Members, open their photos, and download headshots in the sizes your organization needs","\u002Fdocs\u002Fteam-lead\u002Fteam-headshots\u002Fviewing-team-headshots","viewing-team-headshots",[420,424,428,432,436],{"slug":421,"name":422,"articles":423},"billing","Billing",[254,260,265,270],{"slug":425,"name":426,"articles":427},"getting-started","Getting Started",[275,281,284,289,294,299],{"slug":429,"name":430,"articles":431},"integrations","Integrations",[304,306,311],{"slug":433,"name":434,"articles":435},"managing-your-team","Managing Your Team",[314,320,325,330,335,340,345,350,355,360],{"slug":437,"name":438,"articles":439},"team-headshots","Team Headshots",[363,369,374,379,384,389,394,399,404,409,414],[],false,1793943944851]