[{"data":1,"prerenderedAt":585},["ShallowReactive",2],{"api-organization":3},{"article":4,"sections":550,"prevSection":555,"nextSection":559},{"id":5,"title":6,"avatar":7,"body":8,"description":542,"docx":7,"extension":543,"meta":544,"navigation":545,"order":76,"path":546,"pdf":7,"pdfLabel":7,"procurementPack":7,"seo":547,"slug":14,"stem":548,"__hash__":549},"content\u002Fapi\u002Forganization.md","Organization",null,{"type":9,"value":10,"toc":528},"minimark",[11,15,19,24,27,38,43,83,87,259,263,360,363,367,370,376,379,403,406,440,443,470,474,477,487,495,506,510,513,524],[12,13,6],"h1",{"id":14},"organization",[16,17,18],"p",{},"Endpoints for retrieving your organization's details and credit balance.",[20,21,23],"h2",{"id":22},"get-organization-details","Get Organization Details",[16,25,26],{},"Returns your organization's profile information and list of teams.",[28,29,34],"pre",{"className":30,"code":32,"language":33},[31],"language-text","GET \u002Forganization\n","text",[35,36,32],"code",{"__ignoreMap":37},"",[39,40,42],"h3",{"id":41},"request","Request",[28,44,48],{"className":45,"code":46,"language":47,"meta":37,"style":37},"language-bash shiki shiki-themes dark-plus","curl -X GET \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n","bash",[35,49,50,74],{"__ignoreMap":37},[51,52,55,59,63,67,70],"span",{"class":53,"line":54},"line",1,[51,56,58],{"class":57},"sCudf","curl",[51,60,62],{"class":61},"scz_3"," -X",[51,64,66],{"class":65},"sKc5r"," GET",[51,68,69],{"class":65}," \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\"",[51,71,73],{"class":72},"svVle"," \\\n",[51,75,77,80],{"class":53,"line":76},2,[51,78,79],{"class":61},"  -H",[51,81,82],{"class":65}," \"Authorization: Bearer YOUR_API_KEY\"\n",[39,84,86],{"id":85},"response","Response",[28,88,92],{"className":89,"code":90,"language":91,"meta":37,"style":37},"language-json shiki shiki-themes dark-plus","{\n  \"success\": true,\n  \"organization\": {\n    \"uid\": \"org_abc123def456\",\n    \"name\": \"Acme Corporation\",\n    \"website\": \"https:\u002F\u002Facme.com\",\n    \"teams\": [\n      {\n        \"id\": \"team_xyz789\",\n        \"name\": \"Marketing\"\n      },\n      {\n        \"id\": \"team_abc123\",\n        \"name\": \"Engineering\"\n      }\n    ]\n  }\n}\n","json",[35,93,94,100,115,124,137,150,163,172,178,191,202,208,213,225,235,241,247,253],{"__ignoreMap":37},[51,95,96],{"class":53,"line":54},[51,97,99],{"class":98},"sTNBD","{\n",[51,101,102,106,109,112],{"class":53,"line":76},[51,103,105],{"class":104},"s3F5K","  \"success\"",[51,107,108],{"class":98},": ",[51,110,111],{"class":61},"true",[51,113,114],{"class":98},",\n",[51,116,118,121],{"class":53,"line":117},3,[51,119,120],{"class":104},"  \"organization\"",[51,122,123],{"class":98},": {\n",[51,125,127,130,132,135],{"class":53,"line":126},4,[51,128,129],{"class":104},"    \"uid\"",[51,131,108],{"class":98},[51,133,134],{"class":65},"\"org_abc123def456\"",[51,136,114],{"class":98},[51,138,140,143,145,148],{"class":53,"line":139},5,[51,141,142],{"class":104},"    \"name\"",[51,144,108],{"class":98},[51,146,147],{"class":65},"\"Acme Corporation\"",[51,149,114],{"class":98},[51,151,153,156,158,161],{"class":53,"line":152},6,[51,154,155],{"class":104},"    \"website\"",[51,157,108],{"class":98},[51,159,160],{"class":65},"\"https:\u002F\u002Facme.com\"",[51,162,114],{"class":98},[51,164,166,169],{"class":53,"line":165},7,[51,167,168],{"class":104},"    \"teams\"",[51,170,171],{"class":98},": [\n",[51,173,175],{"class":53,"line":174},8,[51,176,177],{"class":98},"      {\n",[51,179,181,184,186,189],{"class":53,"line":180},9,[51,182,183],{"class":104},"        \"id\"",[51,185,108],{"class":98},[51,187,188],{"class":65},"\"team_xyz789\"",[51,190,114],{"class":98},[51,192,194,197,199],{"class":53,"line":193},10,[51,195,196],{"class":104},"        \"name\"",[51,198,108],{"class":98},[51,200,201],{"class":65},"\"Marketing\"\n",[51,203,205],{"class":53,"line":204},11,[51,206,207],{"class":98},"      },\n",[51,209,211],{"class":53,"line":210},12,[51,212,177],{"class":98},[51,214,216,218,220,223],{"class":53,"line":215},13,[51,217,183],{"class":104},[51,219,108],{"class":98},[51,221,222],{"class":65},"\"team_abc123\"",[51,224,114],{"class":98},[51,226,228,230,232],{"class":53,"line":227},14,[51,229,196],{"class":104},[51,231,108],{"class":98},[51,233,234],{"class":65},"\"Engineering\"\n",[51,236,238],{"class":53,"line":237},15,[51,239,240],{"class":98},"      }\n",[51,242,244],{"class":53,"line":243},16,[51,245,246],{"class":98},"    ]\n",[51,248,250],{"class":53,"line":249},17,[51,251,252],{"class":98},"  }\n",[51,254,256],{"class":53,"line":255},18,[51,257,258],{"class":98},"}\n",[39,260,262],{"id":261},"response-fields","Response Fields",[264,265,266,282],"table",{},[267,268,269],"thead",{},[270,271,272,276,279],"tr",{},[273,274,275],"th",{},"Field",[273,277,278],{},"Type",[273,280,281],{},"Description",[283,284,285,299,311,323,336,348],"tbody",{},[270,286,287,293,296],{},[288,289,290],"td",{},[35,291,292],{},"uid",[288,294,295],{},"string",[288,297,298],{},"Unique organization identifier",[270,300,301,306,308],{},[288,302,303],{},[35,304,305],{},"name",[288,307,295],{},[288,309,310],{},"Organization display name",[270,312,313,318,320],{},[288,314,315],{},[35,316,317],{},"website",[288,319,295],{},[288,321,322],{},"Organization website URL",[270,324,325,330,333],{},[288,326,327],{},[35,328,329],{},"teams",[288,331,332],{},"array",[288,334,335],{},"List of teams in the organization",[270,337,338,343,345],{},[288,339,340],{},[35,341,342],{},"teams[].id",[288,344,295],{},[288,346,347],{},"Team identifier",[270,349,350,355,357],{},[288,351,352],{},[35,353,354],{},"teams[].name",[288,356,295],{},[288,358,359],{},"Team display name",[361,362],"hr",{},[20,364,366],{"id":365},"get-credit-balance","Get Credit Balance",[16,368,369],{},"Returns your organization's current credit balance.",[28,371,374],{"className":372,"code":373,"language":33},[31],"GET \u002Forganization\u002Fcredits\n",[35,375,373],{"__ignoreMap":37},[39,377,42],{"id":378},"request-1",[28,380,382],{"className":45,"code":381,"language":47,"meta":37,"style":37},"curl -X GET \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\u002Fcredits\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n",[35,383,384,397],{"__ignoreMap":37},[51,385,386,388,390,392,395],{"class":53,"line":54},[51,387,58],{"class":57},[51,389,62],{"class":61},[51,391,66],{"class":65},[51,393,394],{"class":65}," \"https:\u002F\u002Fserver.headshotpro.com\u002Fapi\u002Fv2\u002Forganization\u002Fcredits\"",[51,396,73],{"class":72},[51,398,399,401],{"class":53,"line":76},[51,400,79],{"class":61},[51,402,82],{"class":65},[39,404,86],{"id":405},"response-1",[28,407,409],{"className":89,"code":408,"language":91,"meta":37,"style":37},"{\n  \"success\": true,\n  \"credits\": 100\n}\n",[35,410,411,415,425,436],{"__ignoreMap":37},[51,412,413],{"class":53,"line":54},[51,414,99],{"class":98},[51,416,417,419,421,423],{"class":53,"line":76},[51,418,105],{"class":104},[51,420,108],{"class":98},[51,422,111],{"class":61},[51,424,114],{"class":98},[51,426,427,430,432],{"class":53,"line":117},[51,428,429],{"class":104},"  \"credits\"",[51,431,108],{"class":98},[51,433,435],{"class":434},"sDGX8","100\n",[51,437,438],{"class":53,"line":126},[51,439,258],{"class":98},[39,441,262],{"id":442},"response-fields-1",[264,444,445,455],{},[267,446,447],{},[270,448,449,451,453],{},[273,450,275],{},[273,452,278],{},[273,454,281],{},[283,456,457],{},[270,458,459,464,467],{},[288,460,461],{},[35,462,463],{},"credits",[288,465,466],{},"integer",[288,468,469],{},"Available credits for headshot generation",[39,471,473],{"id":472},"credit-usage","Credit Usage",[16,475,476],{},"Credits are consumed when:",[478,479,480,484],"ul",{},[481,482,483],"li",{},"A team member uploads their photos and starts the AI training process",[481,485,486],{},"A whitelabel model completes onboarding",[16,488,489,490,494],{},"Credits are ",[491,492,493],"strong",{},"not"," consumed when:",[478,496,497,500,503],{},[481,498,499],{},"Creating an invite (credit reserved, consumed on photo upload)",[481,501,502],{},"Retrieving photos or model details",[481,504,505],{},"Managing teams",[39,507,509],{"id":508},"monitoring-credits","Monitoring Credits",[16,511,512],{},"We recommend monitoring your credit balance programmatically to:",[478,514,515,518,521],{},[481,516,517],{},"Alert when credits are low",[481,519,520],{},"Prevent invite failures due to insufficient credits",[481,522,523],{},"Track usage across teams",[525,526,527],"style",{},"html pre.shiki code .sCudf, html code.shiki .sCudf{--shiki-default:#DCDCAA}html pre.shiki code .scz_3, html code.shiki .scz_3{--shiki-default:#569CD6}html pre.shiki code .sKc5r, html code.shiki .sKc5r{--shiki-default:#CE9178}html pre.shiki code .svVle, html code.shiki .svVle{--shiki-default:#D7BA7D}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sTNBD, html code.shiki .sTNBD{--shiki-default:#D4D4D4}html pre.shiki code .s3F5K, html code.shiki .s3F5K{--shiki-default:#9CDCFE}html pre.shiki code .sDGX8, html code.shiki .sDGX8{--shiki-default:#B5CEA8}",{"title":37,"searchDepth":76,"depth":76,"links":529},[530,535],{"id":22,"depth":76,"text":23,"children":531},[532,533,534],{"id":41,"depth":117,"text":42},{"id":85,"depth":117,"text":86},{"id":261,"depth":117,"text":262},{"id":365,"depth":76,"text":366,"children":536},[537,538,539,540,541],{"id":378,"depth":117,"text":42},{"id":405,"depth":117,"text":86},{"id":442,"depth":117,"text":262},{"id":472,"depth":117,"text":473},{"id":508,"depth":117,"text":509},"Retrieve organization details and credit balance","md",{},true,"\u002Fapi\u002Forganization",{"title":6,"description":542},"api\u002Forganization","JhVnBU9Q8Ok1VrFgjQSd2C7MIyV-orv0H04OHml9zlU",[551,555,558,559,562,564,567,570,573,576,579,582],{"title":552,"slug":553,"order":554},"API Overview","index",0,{"title":556,"slug":557,"order":54},"Authentication","authentication",{"title":6,"slug":14,"order":76},{"title":560,"slug":561,"order":117},"Invites","invites",{"title":563,"slug":329,"order":126},"Teams",{"title":565,"slug":566,"order":139},"Team Members","team-members",{"title":568,"slug":569,"order":152},"Models","models",{"title":571,"slug":572,"order":165},"Photos","photos",{"title":574,"slug":575,"order":174},"Whitelabel","whitelabel",{"title":577,"slug":578,"order":180},"Errors","errors",{"title":580,"slug":581,"order":193},"Rate Limits","rate-limits",{"title":583,"slug":584,"order":204},"Webhooks","webhooks",1792465014346]