{"openapi":"3.1.0","x-id":["reitit.openapi/default"],"info":{"title":"TeamOhana Public API","description":"Refer to the [API FAQ](/faq) for more details on the usage.\n\nNote: API keys for the SCIM API and the Headcount API are different. Please make sure you are using the right keys.","version":"1.0","termsOfService":"https://www.teamohana.com/terms-and-conditions"},"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}}},"security":[{"Authorization":[]}],"paths":{"/{domain}/ServiceProviderConfig":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"type":"string"}},"authenticationSchemes":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["httpdigest","oauth2","httpbasic","oauthbearertoken","oauth"],"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"specUri":{"type":"string"},"documentationUri":{"type":"string"}},"required":["type","name","description"]}},"sort":{"type":"object","properties":{"supported":{"type":"boolean"}},"required":["supported"],"title":"ohana.common.schemas.scim.service-prodvider/sort"},"changePassword":{"type":"object","properties":{"supported":{"type":"boolean"}},"required":["supported"],"title":"ohana.common.schemas.scim.service-prodvider/changePassword"},"patch":{"type":"object","properties":{"supported":{"type":"boolean"}},"required":["supported"],"title":"ohana.common.schemas.scim.service-prodvider/patch"},"filter":{"type":"object","properties":{"supported":{"type":"boolean"},"maxResults":{"type":"integer","format":"int64"}},"required":["supported","maxResults"],"title":"ohana.common.schemas.scim.service-prodvider/filter"},"etag":{"type":"object","properties":{"supported":{"type":"boolean"}},"required":["supported"],"title":"ohana.common.schemas.scim.service-prodvider/etag"},"documentationUri":{"type":"string"},"bulk":{"type":"object","properties":{"supported":{"type":"boolean"},"maxOperations":{"type":"integer","format":"int64"},"maxPayloadSize":{"type":"integer","format":"int64"}},"required":["supported","maxOperations","maxPayloadSize"],"title":"ohana.common.schemas.scim.service-prodvider/bulk"}},"required":["authenticationSchemes","bulk","changePassword","etag","filter","patch","schemas","sort"]}}}},"500":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}}},"tags":["SCIM"],"summary":"Fetch server capabilities","description":"This API is used to figure out all the SCIM features supported by us. Currently all the features except changePassword are unsupported and the supported authentication scheme is basic auth."}},"/{domain}/Users/{id}":{"get":{"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"No such resource found. Please check the id or filters again.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"400":{"description":"Request does not conform to the SCIM standard. Check for typos or missing fields.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}},"scimType":{"enum":["invalidSyntax","noTarget","invalidValue","invalidPath","sensitive","invalidFilter","uniqueness","tooMany","mutability","invalidVers"],"type":"string"}},"required":["detail","schemas","status"]}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"profileUrl":{"type":"string"},"schemas":{},"nickname":{"type":"string"},"preferredLanguage":{"type":"string"},"ims":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"timezone":{"type":"string"},"displayName":{"type":"string"},"id":{"type":"string"},"userType":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"honorificPrefix":{"type":"string"},"honorificSuffix":{"type":"string"}},"title":"ohana.common.schemas.scim.user/name"},"locale":{"type":"string"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.scim.user/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},"userName":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"formatted":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}}},"title":{"type":"string"},"meta":{"type":"object","properties":{"resourceType":{"enum":["user"],"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string"},"version":{"type":"string","format":"uuid"}},"required":["resourceType","created","lastModified","location","version"],"title":"ohana.common.schemas.scim.common/meta"},"password":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"x509Certificates":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"active":{"type":"boolean"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other","teamohana"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"title":"ohana.common.schemas.scim.user/role"}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"externalId":{"type":"string"}},"required":["id","meta","schemas","userName"]}}}}},"tags":["SCIM"],"summary":"Fetch a user","description":"Given an id return all the fields stored by TeamOhana. As per SCIM specification passwords will not be returned."},"put":{"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"profileUrl":{"type":"string"},"schemas":{},"nickname":{"type":"string"},"preferredLanguage":{"type":"string"},"ims":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"timezone":{"type":"string"},"displayName":{"type":"string"},"userType":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"honorificPrefix":{"type":"string"},"honorificSuffix":{"type":"string"}},"title":"ohana.common.schemas.scim.user/name"},"locale":{"type":"string"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.scim.user/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},"userName":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"formatted":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}}},"title":{"type":"string"},"password":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"x509Certificates":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"active":{"type":"boolean"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other","teamohana"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"title":"ohana.common.schemas.scim.user/role"}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}}},"required":["schemas","userName"],"title":"ohana.common.schemas.scim.user/user"}}}},"responses":{"404":{"description":"No such resource found. Please check the id or filters again.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"400":{"description":"Request does not conform to the SCIM standard. Check for typos or missing fields.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}},"scimType":{"enum":["invalidSyntax","noTarget","invalidValue","invalidPath","sensitive","invalidFilter","uniqueness","tooMany","mutability","invalidVers"],"type":"string"}},"required":["detail","schemas","status"]}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"profileUrl":{"type":"string"},"schemas":{},"nickname":{"type":"string"},"preferredLanguage":{"type":"string"},"ims":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"timezone":{"type":"string"},"displayName":{"type":"string"},"id":{"type":"string"},"userType":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"honorificPrefix":{"type":"string"},"honorificSuffix":{"type":"string"}},"title":"ohana.common.schemas.scim.user/name"},"locale":{"type":"string"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.scim.user/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},"userName":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"formatted":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}}},"title":{"type":"string"},"meta":{"type":"object","properties":{"resourceType":{"enum":["user"],"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string"},"version":{"type":"string","format":"uuid"}},"required":["resourceType","created","lastModified","location","version"],"title":"ohana.common.schemas.scim.common/meta"},"password":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"x509Certificates":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"active":{"type":"boolean"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other","teamohana"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"title":"ohana.common.schemas.scim.user/role"}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"externalId":{"type":"string"}},"required":["id","meta","schemas","userName"]}}}}},"tags":["SCIM"],"summary":"Update a user","description":"Given an id and a body update the data in TeamOhana and return the update payload. As per SCIM specification passwords will not be returned. Passwords can still be updated since they have a writeOnly mutability. This API can be used to activate and deactivate a user."},"delete":{"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"No such resource found. Please check the id or filters again.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"400":{"description":"Request does not conform to the SCIM standard. Check for typos or missing fields.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}},"scimType":{"enum":["invalidSyntax","noTarget","invalidValue","invalidPath","sensitive","invalidFilter","uniqueness","tooMany","mutability","invalidVers"],"type":"string"}},"required":["detail","schemas","status"]}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"tags":["SCIM"],"summary":"Delete a user","description":"Given an id delete the user. As per SCIM specification return an empty body on successful deletion."}},"/{domain}/Users":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"integer","format":"int64","minimum":1}]}},{"name":"startIndex","in":"query","description":"","required":false,"schema":{"type":"integer","format":"int64","minimum":1}},{"name":"filter","in":"query","description":"","required":false,"schema":{}}],"responses":{"400":{"description":"Request does not conform to the SCIM standard. Check for typos or missing fields.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}},"scimType":{"enum":["invalidSyntax","noTarget","invalidValue","invalidPath","sensitive","invalidFilter","uniqueness","tooMany","mutability","invalidVers"],"type":"string"}},"required":["detail","schemas","status"]}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"200":{"description":"A list response containing all the users.","content":{"application/json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","items":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"profileUrl":{"type":"string"},"nickname":{"type":"string"},"preferredLanguage":{"type":"string"},"ims":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"timezone":{"type":"string"},"displayName":{"type":"string"},"userType":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"honorificPrefix":{"type":"string"},"honorificSuffix":{"type":"string"}},"title":"ohana.common.schemas.scim.user/name"},"locale":{"type":"string"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.scim.user/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},"userName":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"formatted":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}}},"title":{"type":"string"},"password":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"x509Certificates":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"active":{"type":"boolean"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other","teamohana"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"title":"ohana.common.schemas.scim.user/role"}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}}},"required":["userName"],"title":"ohana.common.schemas.scim.user/user-wo-schema"}},"schemas":{"type":"array","items":{"enum":["list-response"],"type":"string"}},"totalResults":{"anyOf":[{"type":"integer"},{"type":"integer","format":"int64","minimum":1}]},"startIndex":{"type":"integer","format":"int64","minimum":1},"itemsPerPage":{"anyOf":[{"type":"integer"},{"type":"integer","format":"int64","minimum":1}]}},"required":["Resources","schemas","totalResults"],"title":"ohana.common.schemas.scim.users/result"}}}}},"tags":["SCIM"],"summary":"Fetch all the users in TeamOhana.","description":"Get a list of all the users that exists in TeamOhana."},"post":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"profileUrl":{"type":"string"},"schemas":{},"nickname":{"type":"string"},"preferredLanguage":{"type":"string"},"ims":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"timezone":{"type":"string"},"displayName":{"type":"string"},"userType":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"honorificPrefix":{"type":"string"},"honorificSuffix":{"type":"string"}},"title":"ohana.common.schemas.scim.user/name"},"locale":{"type":"string"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.scim.user/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},"userName":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"formatted":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}}},"title":{"type":"string"},"create-in-auth0":{"type":"boolean"},"password":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"x509Certificates":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"active":{"type":"boolean"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other","teamohana"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"title":"ohana.common.schemas.scim.user/role"}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"externalId":{"type":"string"}},"required":["schemas","userName"]}}}},"responses":{"400":{"description":"Request does not conform to the SCIM standard. Check for typos or missing fields.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}},"scimType":{"enum":["invalidSyntax","noTarget","invalidValue","invalidPath","sensitive","invalidFilter","uniqueness","tooMany","mutability","invalidVers"],"type":"string"}},"required":["detail","schemas","status"]}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"profileUrl":{"type":"string"},"schemas":{},"nickname":{"type":"string"},"preferredLanguage":{"type":"string"},"ims":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"timezone":{"type":"string"},"displayName":{"type":"string"},"id":{"type":"string"},"userType":{"type":"string"},"name":{"type":"object","properties":{"formatted":{"type":"string"},"familyName":{"type":"string"},"givenName":{"type":"string"},"middleName":{"type":"string"},"honorificPrefix":{"type":"string"},"honorificSuffix":{"type":"string"}},"title":"ohana.common.schemas.scim.user/name"},"locale":{"type":"string"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.scim.user/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},"userName":{"type":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"primary":{"type":"boolean"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"formatted":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}}},"title":{"type":"string"},"meta":{"type":"object","properties":{"resourceType":{"enum":["user"],"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string"},"version":{"type":"string","format":"uuid"}},"required":["resourceType","created","lastModified","location","version"],"title":"ohana.common.schemas.scim.common/meta"},"password":{"type":"string"},"photos":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"x509Certificates":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"emails":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"active":{"type":"boolean"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"roles":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other","teamohana"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"title":"ohana.common.schemas.scim.user/role"}},"groups":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"primary":{"type":"boolean"},"display":{"type":"string"},"type":{"oneOf":[{"enum":["","home","work","other"],"type":"string"},{"type":"null"}]},"$ref":{"type":"string"}},"required":["value"]}},"externalId":{"type":"string"}},"required":["id","meta","schemas","userName"]}}}},"409":{"description":"A resource with the same email already exists in the system.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"enum":[307,401,412,308,500,501,413,404,409,400,403],"type":"string"},"detail":{"type":"string"},"schemas":{"type":"array","items":{"enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"type":"string"}}},"required":["status","detail","schemas"],"title":"ohana.public-api.web.routes.all/scim-error"}}}}},"tags":["SCIM"],"summary":"Create a user","description":"Given a body create the user in TeamOhana and return it to the user. If the password is not provided during creation a randomly generated password will be set for the user. The username should be an email id OR the emails field should contain at least one email with type work. The API will fail to create the user otherwise. By default the user is also provisioned in Auth0; set `create-in-auth0` to `false` in the body when the user already exists in Auth0 (e.g. via SSO) — in that case `externalId` must be set to the Auth0 user_id. The user's role is taken from the `roles` attribute: the `value` of the entry whose `type` is `teamohana` (case-sensitive), is matched against the org's role names. When no such entry is present the user defaults to the `employee` role; when a matching role is supplied but does not exist the request fails with 400 `invalidValue`."}},"/{domain}/v1/headcount":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"plan-id","in":"query","description":"Filter by hiring plan UUID. Get IDs from GET /v1/plans.","required":false,"schema":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by hiring plan UUID. Get IDs from GET /v1/plans.","title":"ohana.common.schemas.public-api.headcount-filters/plan-id"}},{"name":"hc-status","in":"query","description":"Filter by headcount status code. Repeatable for OR. Valid values: in-approval, approved, denied, closed, archived.","required":false,"schema":{"anyOf":[{},{"type":"array","items":{}}],"description":"Filter by headcount status code. Repeatable for OR. Valid values: in-approval, approved, denied, closed, archived.","title":"ohana.common.schemas.public-api.headcount-filters/hc-status"}},{"name":"hc-hiring-status","in":"query","description":"Filter by hiring status code. Repeatable for OR. Valid values: not-started, ready-to-hire, in-progress, offer-sent, hired.","required":false,"schema":{"anyOf":[{},{"type":"array","items":{}}],"description":"Filter by hiring status code. Repeatable for OR. Valid values: not-started, ready-to-hire, in-progress, offer-sent, hired.","title":"ohana.common.schemas.public-api.headcount-filters/hc-hiring-status"}},{"name":"department-id","in":"query","description":"Filter by department. Pass the id returned by GET /v1/departments (a division-department UUID that uniquely identifies a department within a division).","required":false,"schema":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by department. Pass the id returned by GET /v1/departments (a division-department UUID that uniquely identifies a department within a division).","title":"ohana.common.schemas.public-api.headcount-filters/department-id"}},{"name":"division-id","in":"query","description":"Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union.","required":false,"schema":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union.","title":"ohana.common.schemas.public-api.headcount-filters/division-id"}}],"responses":{"401":{"description":"Request does not contain valid credentials.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}},"text/csv":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}},"text/csv":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}}}},"200":{"description":"A list of headcounts as either a JSON array or a CSV file.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"termination-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Termination date of the employee if exists.","title":"ohana.common.schemas.public-api.headcount/termination-date","example":"08-26-2024"},"hiring-status":{"oneOf":[{"enum":["Offer Sent","Hired","Ready to hire","Not started","In progress"],"type":"string"},{"type":"null"}],"description":"Current status of the headcount.","title":"ohana.common.schemas.public-api.headcount/hiring-status","example":"Hired"},"employee-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Type of the employee.","title":"ohana.common.schemas.public-api.headcount/employee-type","example":"Full Time"},"department":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Department of the Headcount.","title":"ohana.common.schemas.public-api.headcount/department","example":"Sales"},"headcount-approved-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Approved date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/headcount-approved-date","example":"08-26-2024"},"target-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target variable of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-variable","example":"1234.0"},"target-equity-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Equity currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-equity-currency","example":"USD"},"priority":{"oneOf":[{"enum":["High","Normal","Critical","Low"],"type":"string"},{"type":"null"}],"description":"Priority of the Headcount.","title":"ohana.common.schemas.public-api.headcount/priority","example":"Normal"},"target-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target equity of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-equity","example":4321.0},"custom-fields":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.public-api.headcount/name-value"},"description":"All custom fields associated with this Headcount.","title":"ohana.common.schemas.public-api.headcount/custom-fields","example":{"HEADCOUNT":{"Field 1":"Value 1","Field 2":null,"Field 3":123},"EMPLOYEE":{"Field 1":"Value 1","Field 2":"Value 2","Field 3":321},"OFFER":{"Field 1":null,"Field 2":null,"Field 3":"Value 3"}}},"opening-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Opening ID of the Headcount.","title":"ohana.common.schemas.public-api.headcount/opening-id","example":"1234-123"},"budget-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget equity of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-equity","example":44000.0},"headcount-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount ID exists in TeamOhana.","title":"ohana.common.schemas.public-api.headcount/headcount-id","example":"ORG-123"},"sourcers":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Names of the sourcers split by `;`","title":"ohana.common.schemas.public-api.headcount/sourcers","example":"Stephen Marshall ; Mark Henry"},"actual-bonus":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual bonus of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-bonus","example":8484.0},"budget-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget salary of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-salary","example":205000.0},"reporting-manager":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the reporting manager.","title":"ohana.common.schemas.public-api.headcount/reporting-manager","example":"Stephen Marshall"},"termination-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Termination type of the employee if exists.","title":"ohana.common.schemas.public-api.headcount/termination-type","example":"Initiative Name"},"recruiters":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Names of the recruiters split by `;`","title":"ohana.common.schemas.public-api.headcount/recruiters","example":"Stephen Marshall ; Mark Henry"},"annualized-budget-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget salary calculated annually.","title":"ohana.common.schemas.public-api.headcount/annualized-budget-salary","example":2460000.0},"target-bonus-perc":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target bonus-perc of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-bonus-perc","example":10},"actual-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual equity of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-equity","example":4321.0},"actual-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual variable of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-variable","example":1324.0},"compensation-change-reason":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/compensation-change-reason","example":"ABC"},"budget-job-level":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget job level of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-job-level","example":"L1"},"headcount-type":{"oneOf":[{"enum":["Backfill","New hire"],"type":"string"},{"type":"null"}],"description":"Type of the Headcount - either New hire or Backfill.","title":"ohana.common.schemas.public-api.headcount/headcount-type","example":"New hire"},"id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"headcount UUID.","title":"ohana.common.schemas.public-api.headcount/id","example":"uuid"},"archived-justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Justification of archival if the Headcount is archived.","title":"ohana.common.schemas.public-api.headcount/archived-justification","example":"Not required"},"archived-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Archival date of the Headcount if this is archived.","title":"ohana.common.schemas.public-api.headcount/archived-date","example":"08-26-2024"},"headcount-display-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount ID","title":"ohana.common.schemas.public-api.headcount/headcount-display-id","example":"ABC-123"},"backfill-employee-email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Email of the backfill employee if this Headcount is a backfill.","title":"ohana.common.schemas.public-api.headcount/backfill-employee-email","example":"ramzi.ali@example.com"},"headcount-denied-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Denied date of the Headcount if this is denied.","title":"ohana.common.schemas.public-api.headcount/headcount-denied-date","example":"08-26-2024"},"headcount-is-private":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Headcount is private.","title":"ohana.common.schemas.public-api.headcount/headcount-is-private","example":true},"actual-bonus-perc":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual bonus-perc of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-bonus-perc","example":10},"target-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target start date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-start-date","example":"08-26-2024"},"budget-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget start date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-start-date","example":"08-26-2024"},"is-current":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Headcount is included in current hiring plan or not.","title":"ohana.common.schemas.public-api.headcount/is-current","example":true},"division":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Division of the Headcount.","title":"ohana.common.schemas.public-api.headcount/division","example":"Engineering"},"employee-email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employee email","title":"ohana.common.schemas.public-api.headcount/employee-email","example":"a@b.com"},"budget-pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget pay rate of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-pay-rate","example":"YEAR"},"hris-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Employee ID","title":"ohana.common.schemas.public-api.headcount/hris-employee-id","example":"1234"},"job-level":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job level of the Headcount.","title":"ohana.common.schemas.public-api.headcount/job-level","example":"L2"},"job-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job name of the Headcount - concatenation of ATS job-id and job name.","title":"ohana.common.schemas.public-api.headcount/job-name","example":"GH-1234 - Sales Director, Generative AI"},"denied-justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Justification of denial if the Headcount is denied.","title":"ohana.common.schemas.public-api.headcount/denied-justification","example":"Not Suitable"},"hiring-plan-active":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Headcount is included in current hiring plan or not.","title":"ohana.common.schemas.public-api.headcount/hiring-plan-active","example":true},"actual-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual salary of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-salary","example":"2345.0"},"location":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Location of the Headcount.","title":"ohana.common.schemas.public-api.headcount/location","example":"San francisco, USA"},"employee-id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Employee ID.","title":"ohana.common.schemas.public-api.headcount/employee-id","example":"uuid"},"reporting-manager-email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Email of the reporting manager.","title":"ohana.common.schemas.public-api.headcount/reporting-manager-email","example":"stephen.marshall@example.com"},"last-updated":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Last update date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/last-updated","example":"2024-07-15T00:00:00Z"},"headcount-status":{"oneOf":[{"enum":["Filled","Approved","Denied","In Approval","Archived"],"type":"string"},{"type":"null"}],"description":"Current status of the Headcount.","title":"ohana.common.schemas.public-api.headcount/headcount-status","example":"Approved"},"actual-equity-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Actual Equity currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-equity-currency","example":"USD"},"status":{"oneOf":[{"enum":["Filled","Approved","Denied","In Approval","Archived"],"type":"string"},{"type":"null"}],"description":"Current status of the Headcount.","title":"ohana.common.schemas.public-api.headcount/status","example":"Approved"},"actual-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Actual start date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-start-date","example":"08-26-2024"},"target-open-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target open date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-open-date","example":"08-26-2024"},"pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pay rate of the Headcount.","title":"ohana.common.schemas.public-api.headcount/pay-rate","example":"YEAR"},"target-bonus":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target bonus of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-bonus","example":8484.0},"budget-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-currency","example":"USD"},"job-title":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job title of the Headcount.","title":"ohana.common.schemas.public-api.headcount/job-title","example":"Software Engineer"},"future-termination":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Is the employee termination in future","title":"ohana.common.schemas.public-api.headcount/future-termination","example":true},"backfill-employee":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the backfill employee for this Headcount.","title":"ohana.common.schemas.public-api.headcount/backfill-employee","example":"Ramzi Ali"},"annualized-actual-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual salary calculated annually.","title":"ohana.common.schemas.public-api.headcount/annualized-actual-salary","example":28140.0},"backfill-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employee ID of backfilled employee for the Headcount.","title":"ohana.common.schemas.public-api.headcount/backfill-employee-id","example":"1234"},"track-management":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/track-management","example":"ABC"},"hris-employee-remote-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Remote Employee ID","title":"ohana.common.schemas.public-api.headcount/hris-employee-remote-id","example":"1234"},"target-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target salary of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-salary","example":84840.0},"target-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-currency","example":"USD"},"hiring-plan":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the hiring plan","title":"ohana.common.schemas.public-api.headcount/hiring-plan","example":"FY Hiring plan 2025"},"state":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/state","example":"S"},"annualized-target-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target salary calculated annually for this Headcount.","title":"ohana.common.schemas.public-api.headcount/annualized-target-salary","example":1018080.0},"employee-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the employee.","title":"ohana.common.schemas.public-api.headcount/employee-name","example":"Terry Peters"},"offer-sent-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Offer sent date for the headcount if exists.","title":"ohana.common.schemas.public-api.headcount/offer-sent-date","example":"08-26-2024"},"actual-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Actual currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-currency","example":"USD"},"budget-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget variable of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-variable","example":105000.0},"pay-rate-multiplier":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Pay rate multiplier of the Headcount.","title":"ohana.common.schemas.public-api.headcount/pay-rate-multiplier","example":2080},"termination-reconciled":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Was the employee termination reconciled","title":"ohana.common.schemas.public-api.headcount/termination-reconciled","example":true},"job-role":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job role of the Headcount.","title":"ohana.common.schemas.public-api.headcount/job-role","example":"Marketing"},"headcount-url":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"URL of the Headcount details in TeamOhana.","title":"ohana.common.schemas.public-api.headcount/headcount-url","example":"https://app.teamohana.us/headcount-details/1949a6b5-eaeb-4ee3-8d3d-9c597b04c918"},"reporting-manager-hris-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Employee ID of the Reporting manager of the employee","title":"ohana.common.schemas.public-api.headcount/reporting-manager-hris-employee-id","example":"1234"},"offer-accept-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Offer acceptance date for the headcount if exists.","title":"ohana.common.schemas.public-api.headcount/offer-accept-date","example":"08-26-2024"},"team":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount's team name.","title":"ohana.common.schemas.public-api.headcount/team","example":"Sales"},"approval-requested-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Date of approval for this Headcount .","title":"ohana.common.schemas.public-api.headcount/approval-requested-date","example":"08-26-2024"},"initiative":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Initiative name of the Headcount if exists.","title":"ohana.common.schemas.public-api.headcount/initiative","example":"Initiative Name"},"job-function":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/job-function","example":"ABC"},"target-hire-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target hire date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-hire-date","example":"08-26-2024"},"target-pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target pay rate of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-pay-rate","example":"YEAR"},"employment-end-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employment end date for the headcount if exists.","title":"ohana.common.schemas.public-api.headcount/employment-end-date","example":"08-26-2024"},"teamohana-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Teamohana ID","title":"ohana.common.schemas.public-api.headcount/teamohana-id","example":"TO-1234"},"coordinators":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Names of the coordinators split by `;`","title":"ohana.common.schemas.public-api.headcount/coordinators","example":"Stephen Marshall ; Mark Henry"},"justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount Justification","title":"ohana.common.schemas.public-api.headcount/justification","example":"Need additional resource"},"termination-regrettable":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Was the employee termination regrettable","title":"ohana.common.schemas.public-api.headcount/termination-regrettable","example":true}},"required":["employee-name","job-title","division","department","job-level","location","employee-type","reporting-manager","target-start-date"],"title":"ohana.common.schemas.public-api.headcount/headcount-or-employee"},"title":"ohana.common.schemas.public-api.headcount/api-response"}},"text/csv":{"schema":{"type":"string"}}}}},"tags":["Headcount"],"summary":"Fetch all the headcount in TeamOhana.","description":"Get a list of all valid headcount that exists in TeamOhana. Supports optional filtering by plan, status, hiring status, department, and division. Response format is selected via the Accept header (`application/json` default, `text/csv` for a downloadable CSV). Refer to the [Headcount Data API FAQ](/faq/index.html#headcount-data-api) for more details."},"post":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"plan-id","in":"query","description":"Filter by hiring plan UUID. Get IDs from GET /v1/plans.","required":false,"schema":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by hiring plan UUID. Get IDs from GET /v1/plans.","title":"ohana.common.schemas.public-api.headcount-filters/plan-id"}},{"name":"hc-status","in":"query","description":"Filter by headcount status code. Repeatable for OR. Valid values: in-approval, approved, denied, closed, archived.","required":false,"schema":{"anyOf":[{},{"type":"array","items":{}}],"description":"Filter by headcount status code. Repeatable for OR. Valid values: in-approval, approved, denied, closed, archived.","title":"ohana.common.schemas.public-api.headcount-filters/hc-status"}},{"name":"hc-hiring-status","in":"query","description":"Filter by hiring status code. Repeatable for OR. Valid values: not-started, ready-to-hire, in-progress, offer-sent, hired.","required":false,"schema":{"anyOf":[{},{"type":"array","items":{}}],"description":"Filter by hiring status code. Repeatable for OR. Valid values: not-started, ready-to-hire, in-progress, offer-sent, hired.","title":"ohana.common.schemas.public-api.headcount-filters/hc-hiring-status"}},{"name":"department-id","in":"query","description":"Filter by department. Pass the id returned by GET /v1/departments (a division-department UUID that uniquely identifies a department within a division).","required":false,"schema":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by department. Pass the id returned by GET /v1/departments (a division-department UUID that uniquely identifies a department within a division).","title":"ohana.common.schemas.public-api.headcount-filters/department-id"}},{"name":"division-id","in":"query","description":"Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union.","required":false,"schema":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter by division UUID. Get IDs from GET /v1/divisions. When combined with department-id, returns the union.","title":"ohana.common.schemas.public-api.headcount-filters/division-id"}}],"responses":{"401":{"description":"Request does not contain valid credentials.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}}}},"200":{"description":"A list response containing all the headcount.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"termination-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Termination date of the employee if exists.","title":"ohana.common.schemas.public-api.headcount/termination-date","example":"08-26-2024"},"hiring-status":{"oneOf":[{"enum":["Offer Sent","Hired","Ready to hire","Not started","In progress"],"type":"string"},{"type":"null"}],"description":"Current status of the headcount.","title":"ohana.common.schemas.public-api.headcount/hiring-status","example":"Hired"},"employee-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Type of the employee.","title":"ohana.common.schemas.public-api.headcount/employee-type","example":"Full Time"},"department":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Department of the Headcount.","title":"ohana.common.schemas.public-api.headcount/department","example":"Sales"},"headcount-approved-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Approved date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/headcount-approved-date","example":"08-26-2024"},"target-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target variable of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-variable","example":"1234.0"},"target-equity-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Equity currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-equity-currency","example":"USD"},"priority":{"oneOf":[{"enum":["High","Normal","Critical","Low"],"type":"string"},{"type":"null"}],"description":"Priority of the Headcount.","title":"ohana.common.schemas.public-api.headcount/priority","example":"Normal"},"target-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target equity of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-equity","example":4321.0},"custom-fields":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{},"title":"ohana.common.schemas.public-api.headcount/name-value"},"description":"All custom fields associated with this Headcount.","title":"ohana.common.schemas.public-api.headcount/custom-fields","example":{"HEADCOUNT":{"Field 1":"Value 1","Field 2":null,"Field 3":123},"EMPLOYEE":{"Field 1":"Value 1","Field 2":"Value 2","Field 3":321},"OFFER":{"Field 1":null,"Field 2":null,"Field 3":"Value 3"}}},"opening-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Opening ID of the Headcount.","title":"ohana.common.schemas.public-api.headcount/opening-id","example":"1234-123"},"budget-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget equity of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-equity","example":44000.0},"headcount-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount ID exists in TeamOhana.","title":"ohana.common.schemas.public-api.headcount/headcount-id","example":"ORG-123"},"sourcers":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Names of the sourcers split by `;`","title":"ohana.common.schemas.public-api.headcount/sourcers","example":"Stephen Marshall ; Mark Henry"},"actual-bonus":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual bonus of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-bonus","example":8484.0},"budget-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget salary of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-salary","example":205000.0},"reporting-manager":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the reporting manager.","title":"ohana.common.schemas.public-api.headcount/reporting-manager","example":"Stephen Marshall"},"termination-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Termination type of the employee if exists.","title":"ohana.common.schemas.public-api.headcount/termination-type","example":"Initiative Name"},"recruiters":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Names of the recruiters split by `;`","title":"ohana.common.schemas.public-api.headcount/recruiters","example":"Stephen Marshall ; Mark Henry"},"annualized-budget-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget salary calculated annually.","title":"ohana.common.schemas.public-api.headcount/annualized-budget-salary","example":2460000.0},"target-bonus-perc":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target bonus-perc of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-bonus-perc","example":10},"actual-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual equity of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-equity","example":4321.0},"actual-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual variable of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-variable","example":1324.0},"compensation-change-reason":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/compensation-change-reason","example":"ABC"},"budget-job-level":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget job level of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-job-level","example":"L1"},"headcount-type":{"oneOf":[{"enum":["Backfill","New hire"],"type":"string"},{"type":"null"}],"description":"Type of the Headcount - either New hire or Backfill.","title":"ohana.common.schemas.public-api.headcount/headcount-type","example":"New hire"},"id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"headcount UUID.","title":"ohana.common.schemas.public-api.headcount/id","example":"uuid"},"archived-justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Justification of archival if the Headcount is archived.","title":"ohana.common.schemas.public-api.headcount/archived-justification","example":"Not required"},"archived-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Archival date of the Headcount if this is archived.","title":"ohana.common.schemas.public-api.headcount/archived-date","example":"08-26-2024"},"headcount-display-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount ID","title":"ohana.common.schemas.public-api.headcount/headcount-display-id","example":"ABC-123"},"backfill-employee-email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Email of the backfill employee if this Headcount is a backfill.","title":"ohana.common.schemas.public-api.headcount/backfill-employee-email","example":"ramzi.ali@example.com"},"headcount-denied-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Denied date of the Headcount if this is denied.","title":"ohana.common.schemas.public-api.headcount/headcount-denied-date","example":"08-26-2024"},"headcount-is-private":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Headcount is private.","title":"ohana.common.schemas.public-api.headcount/headcount-is-private","example":true},"actual-bonus-perc":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual bonus-perc of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-bonus-perc","example":10},"target-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target start date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-start-date","example":"08-26-2024"},"budget-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget start date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-start-date","example":"08-26-2024"},"is-current":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Headcount is included in current hiring plan or not.","title":"ohana.common.schemas.public-api.headcount/is-current","example":true},"division":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Division of the Headcount.","title":"ohana.common.schemas.public-api.headcount/division","example":"Engineering"},"employee-email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employee email","title":"ohana.common.schemas.public-api.headcount/employee-email","example":"a@b.com"},"budget-pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget pay rate of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-pay-rate","example":"YEAR"},"hris-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Employee ID","title":"ohana.common.schemas.public-api.headcount/hris-employee-id","example":"1234"},"job-level":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job level of the Headcount.","title":"ohana.common.schemas.public-api.headcount/job-level","example":"L2"},"job-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job name of the Headcount - concatenation of ATS job-id and job name.","title":"ohana.common.schemas.public-api.headcount/job-name","example":"GH-1234 - Sales Director, Generative AI"},"denied-justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Justification of denial if the Headcount is denied.","title":"ohana.common.schemas.public-api.headcount/denied-justification","example":"Not Suitable"},"hiring-plan-active":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether the Headcount is included in current hiring plan or not.","title":"ohana.common.schemas.public-api.headcount/hiring-plan-active","example":true},"actual-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual salary of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-salary","example":"2345.0"},"location":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Location of the Headcount.","title":"ohana.common.schemas.public-api.headcount/location","example":"San francisco, USA"},"employee-id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Employee ID.","title":"ohana.common.schemas.public-api.headcount/employee-id","example":"uuid"},"reporting-manager-email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Email of the reporting manager.","title":"ohana.common.schemas.public-api.headcount/reporting-manager-email","example":"stephen.marshall@example.com"},"last-updated":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Last update date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/last-updated","example":"2024-07-15T00:00:00Z"},"headcount-status":{"oneOf":[{"enum":["Filled","Approved","Denied","In Approval","Archived"],"type":"string"},{"type":"null"}],"description":"Current status of the Headcount.","title":"ohana.common.schemas.public-api.headcount/headcount-status","example":"Approved"},"actual-equity-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Actual Equity currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-equity-currency","example":"USD"},"status":{"oneOf":[{"enum":["Filled","Approved","Denied","In Approval","Archived"],"type":"string"},{"type":"null"}],"description":"Current status of the Headcount.","title":"ohana.common.schemas.public-api.headcount/status","example":"Approved"},"actual-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Actual start date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-start-date","example":"08-26-2024"},"target-open-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target open date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-open-date","example":"08-26-2024"},"pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pay rate of the Headcount.","title":"ohana.common.schemas.public-api.headcount/pay-rate","example":"YEAR"},"target-bonus":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target bonus of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-bonus","example":8484.0},"budget-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Budget currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-currency","example":"USD"},"job-title":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job title of the Headcount.","title":"ohana.common.schemas.public-api.headcount/job-title","example":"Software Engineer"},"future-termination":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Is the employee termination in future","title":"ohana.common.schemas.public-api.headcount/future-termination","example":true},"backfill-employee":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the backfill employee for this Headcount.","title":"ohana.common.schemas.public-api.headcount/backfill-employee","example":"Ramzi Ali"},"annualized-actual-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Actual salary calculated annually.","title":"ohana.common.schemas.public-api.headcount/annualized-actual-salary","example":28140.0},"backfill-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employee ID of backfilled employee for the Headcount.","title":"ohana.common.schemas.public-api.headcount/backfill-employee-id","example":"1234"},"track-management":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/track-management","example":"ABC"},"hris-employee-remote-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Remote Employee ID","title":"ohana.common.schemas.public-api.headcount/hris-employee-remote-id","example":"1234"},"target-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target salary of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-salary","example":84840.0},"target-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-currency","example":"USD"},"hiring-plan":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the hiring plan","title":"ohana.common.schemas.public-api.headcount/hiring-plan","example":"FY Hiring plan 2025"},"state":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/state","example":"S"},"annualized-target-salary":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target salary calculated annually for this Headcount.","title":"ohana.common.schemas.public-api.headcount/annualized-target-salary","example":1018080.0},"employee-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the employee.","title":"ohana.common.schemas.public-api.headcount/employee-name","example":"Terry Peters"},"offer-sent-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Offer sent date for the headcount if exists.","title":"ohana.common.schemas.public-api.headcount/offer-sent-date","example":"08-26-2024"},"actual-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Actual currency of the Headcount.","title":"ohana.common.schemas.public-api.headcount/actual-currency","example":"USD"},"budget-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget variable of the Headcount.","title":"ohana.common.schemas.public-api.headcount/budget-variable","example":105000.0},"pay-rate-multiplier":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Pay rate multiplier of the Headcount.","title":"ohana.common.schemas.public-api.headcount/pay-rate-multiplier","example":2080},"termination-reconciled":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Was the employee termination reconciled","title":"ohana.common.schemas.public-api.headcount/termination-reconciled","example":true},"job-role":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job role of the Headcount.","title":"ohana.common.schemas.public-api.headcount/job-role","example":"Marketing"},"headcount-url":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"URL of the Headcount details in TeamOhana.","title":"ohana.common.schemas.public-api.headcount/headcount-url","example":"https://app.teamohana.us/headcount-details/1949a6b5-eaeb-4ee3-8d3d-9c597b04c918"},"reporting-manager-hris-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Employee ID of the Reporting manager of the employee","title":"ohana.common.schemas.public-api.headcount/reporting-manager-hris-employee-id","example":"1234"},"offer-accept-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Offer acceptance date for the headcount if exists.","title":"ohana.common.schemas.public-api.headcount/offer-accept-date","example":"08-26-2024"},"team":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount's team name.","title":"ohana.common.schemas.public-api.headcount/team","example":"Sales"},"approval-requested-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Date of approval for this Headcount .","title":"ohana.common.schemas.public-api.headcount/approval-requested-date","example":"08-26-2024"},"initiative":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Initiative name of the Headcount if exists.","title":"ohana.common.schemas.public-api.headcount/initiative","example":"Initiative Name"},"job-function":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Docker specific field","title":"ohana.common.schemas.public-api.headcount/job-function","example":"ABC"},"target-hire-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target hire date of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-hire-date","example":"08-26-2024"},"target-pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target pay rate of the Headcount.","title":"ohana.common.schemas.public-api.headcount/target-pay-rate","example":"YEAR"},"employment-end-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employment end date for the headcount if exists.","title":"ohana.common.schemas.public-api.headcount/employment-end-date","example":"08-26-2024"},"teamohana-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Teamohana ID","title":"ohana.common.schemas.public-api.headcount/teamohana-id","example":"TO-1234"},"coordinators":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Names of the coordinators split by `;`","title":"ohana.common.schemas.public-api.headcount/coordinators","example":"Stephen Marshall ; Mark Henry"},"justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Headcount Justification","title":"ohana.common.schemas.public-api.headcount/justification","example":"Need additional resource"},"termination-regrettable":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Was the employee termination regrettable","title":"ohana.common.schemas.public-api.headcount/termination-regrettable","example":true}},"required":["employee-name","job-title","division","department","job-level","location","employee-type","reporting-manager","target-start-date"],"title":"ohana.common.schemas.public-api.headcount/headcount-or-employee"},"title":"ohana.common.schemas.public-api.headcount/api-response"}}}}},"tags":["Headcount"],"summary":"Fetch all the headcount in TeamOhana.","description":"Get a list of all valid headcount that exists in TeamOhana. Supports optional filtering by plan, status, hiring status, department, and division. Refer to the [Headcount Data API FAQ](/faq/index.html#headcount-data-api) for more details."}},"/{domain}/v1/headcount/upload/pigment":{"post":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"import-configuration-id":{"type":"string"},"time-period":{"enum":["this-year"],"type":"string","description":"Filter records whose effective start date falls within the org's current fiscal year. Valid values: this-year.","title":"ohana.core.utils.time-periods/time-period"}},"required":["import-configuration-id"]}}}},"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"500":{"description":"Something went wrong. Please contact TeamOhana support.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"200":{"description":"A success message describing the result of the upload.","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["Headcount"],"summary":"Generate headcount CSV and upload it to pigment","description":"Generate the headcount CSV and trigger an async upload to Pigment. Optionally pass time-period in the body (currently only `\"this-year\"` is supported) to scope the CSV to the org's current fiscal year. Refer to the [Pigment Connector API FAQ](/faq/index.html#pigment-connector-api) for more details."}},"/{domain}/v1/plans":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of hiring plans.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID","title":"ohana.common.schemas.public-api.discovery/id"},"name":{"type":"string","description":"Display name","title":"ohana.common.schemas.public-api.discovery/name"},"is-active":{"type":"boolean","description":"Whether this is the currently active plan","title":"ohana.common.schemas.public-api.discovery/is-active"},"start-date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Plan start date","title":"ohana.common.schemas.public-api.discovery/start-date"},"end-date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Plan end date","title":"ohana.common.schemas.public-api.discovery/end-date"}},"required":["id","name","is-active"],"description":"A hiring plan.","title":"ohana.common.schemas.public-api.discovery/plan"},"description":"List of hiring plans for the org.","title":"ohana.common.schemas.public-api.discovery/plans"}}}},"401":{"description":"Request does not contain valid credentials.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}}},"tags":["Discovery"],"summary":"List hiring plans","description":"Returns all hiring plans for the org. Use the returned id to filter GET /v1/headcount by plan."}},"/{domain}/v1/departments":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of departments with division info.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID","title":"ohana.common.schemas.public-api.discovery/id"},"name":{"type":"string","description":"Display name","title":"ohana.common.schemas.public-api.discovery/name"},"division-id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Parent division UUID. Nil if not linked to a division.","title":"ohana.common.schemas.public-api.discovery/division-id"},"division-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Parent division display name.","title":"ohana.common.schemas.public-api.discovery/division-name"}},"required":["id","name"],"description":"A department, optionally linked to a division.","title":"ohana.common.schemas.public-api.discovery/department"},"description":"List of departments for the org.","title":"ohana.common.schemas.public-api.discovery/departments"}}}},"401":{"description":"Request does not contain valid credentials.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}}},"tags":["Discovery"],"summary":"List departments","description":"Returns all departments with their parent division. Use the returned id to filter GET /v1/headcount by department."}},"/{domain}/v1/divisions":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of divisions.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID","title":"ohana.common.schemas.public-api.discovery/id"},"name":{"type":"string","description":"Display name","title":"ohana.common.schemas.public-api.discovery/name"}},"required":["id","name"],"description":"A division.","title":"ohana.common.schemas.public-api.discovery/division"},"description":"List of divisions for the org.","title":"ohana.common.schemas.public-api.discovery/divisions"}}}},"401":{"description":"Request does not contain valid credentials.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}}},"tags":["Discovery"],"summary":"List divisions","description":"Returns all divisions. Use the returned id to filter GET /v1/headcount by division."}},"/{domain}/v1/scenarios":{"get":{"parameters":[{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"401":{"description":"Request does not contain valid credentials.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}},"text/csv":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}},"text/csv":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}}}},"200":{"description":"A list response containing all scenarios.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"null"}]},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"type":{"enum":["Modify plan","New plan","New or Replan"],"type":"string"},"status":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Current status","title":"ohana.common.schemas.public-api.scenario/status","example":"draft"},"updated-at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"created-at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"title":"ohana.common.schemas.public-api.scenario/scenario"},"description":"List of scenario records","example":[{"id":"SC-123","name":"Next Year Planning","type":"Modify plan","status":"draft","updated-at":"2026-02-04T10:11:05Z","created-at":"2026-01-04T23:23:05Z"}],"title":"ohana.common.schemas.public-api.scenario/scenarios-list-response"}},"text/csv":{"schema":{"type":"string"}}}}},"tags":["Scenario"],"summary":"List all scenarios","description":"Get a list of all scenarios accessible to the API key owner."}},"/{domain}/v1/scenarios/{id}/export":{"get":{"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}},{"name":"domain","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"No such resource found or access denied. Please check the id.","content":{"application/json":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}},"text/csv":{"schema":{"type":"string","title":"ohana.common.schemas.public-api.common/message"}}}},"500":{"description":"Something went wrong at TeamOhana. Please contact support.","content":{"application/json":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}},"text/csv":{"schema":{"title":"ohana.common.schemas.public-api.common/unhandled"}}}},"200":{"description":"A list response containing all headcount and employees within the scenario.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"employee-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Type of employment","title":"ohana.common.schemas.public-api.scenario/employee-type","example":"Full Time"},"department":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Department name","title":"ohana.common.schemas.public-api.scenario/department","example":"Sales"},"equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Equity compensation","title":"ohana.common.schemas.public-api.scenario/equity","example":30000.0},"target-variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target variable pay","title":"ohana.common.schemas.public-api.scenario/target-variable","example":30000.0},"priority":{"oneOf":[{"enum":["High","Normal","Critical","Low"],"type":"string"},{"type":"null"}],"description":"Priority of the Headcount.","title":"ohana.common.schemas.public-api.scenario/priority","example":"Normal"},"entity-type":{"oneOf":[{"enum":["headcount","employee"],"type":"string"},{"type":"null"}],"description":"Type of entity (headcount or employee)","title":"ohana.common.schemas.public-api.scenario/entity-type","example":"headcount"},"target-equity":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target equity","title":"ohana.common.schemas.public-api.scenario/target-equity","example":35000.0},"target-base":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target base pay","title":"ohana.common.schemas.public-api.scenario/target-base","example":155000.0},"opening-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"ATS opening ID","title":"ohana.common.schemas.public-api.scenario/opening-id","example":"1234-567"},"sub-team-field":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Sub-team field","title":"ohana.common.schemas.public-api.scenario/sub-team-field","example":"Platform"},"reporting-manager":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of reporting manager","title":"ohana.common.schemas.public-api.scenario/reporting-manager","example":"Stephen Marshall"},"target-bonus-perc":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target bonus percentage","title":"ohana.common.schemas.public-api.scenario/target-bonus-perc","example":10.0},"headcount-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Type of headcount","title":"ohana.common.schemas.public-api.scenario/headcount-type","example":"New hire"},"budget-type":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Type of budget","title":"ohana.common.schemas.public-api.scenario/budget-type","example":"Budgeted"},"base":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Base pay amount","title":"ohana.common.schemas.public-api.scenario/base","example":150000.0},"sub-team-archived":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether sub-team is archived","title":"ohana.common.schemas.public-api.scenario/sub-team-archived","example":false},"job-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job ID from ATS","title":"ohana.common.schemas.public-api.scenario/job-id","example":"GH-1234"},"pay-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Currency for pay","title":"ohana.common.schemas.public-api.scenario/pay-currency","example":"USD"},"target-start-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Target start date","title":"ohana.common.schemas.public-api.scenario/target-start-date","example":"2024-10-01T00:00:00Z"},"scenario-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Scenario display ID","title":"ohana.common.schemas.public-api.scenario/scenario-id","example":"SC-123"},"division":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Division name","title":"ohana.common.schemas.public-api.scenario/division","example":"Engineering"},"hris-employee-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"HRIS Employee ID","title":"ohana.common.schemas.public-api.scenario/hris-employee-id","example":"EMP-1234"},"remaining-budget":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Remaining budget","title":"ohana.common.schemas.public-api.scenario/remaining-budget","example":5000.0},"job-level":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job level","title":"ohana.common.schemas.public-api.scenario/job-level","example":"L2"},"location":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Work location","title":"ohana.common.schemas.public-api.scenario/location","example":"San Francisco, USA"},"status":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Current status","title":"ohana.common.schemas.public-api.scenario/status","example":"draft"},"variable":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Variable compensation","title":"ohana.common.schemas.public-api.scenario/variable","example":25000.0},"pay-rate":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Pay rate frequency","title":"ohana.common.schemas.public-api.scenario/pay-rate","example":"YEAR"},"target-bonus":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target bonus amount","title":"ohana.common.schemas.public-api.scenario/target-bonus","example":5000.0},"job-title":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job title or role","title":"ohana.common.schemas.public-api.scenario/job-title","example":"Software Engineer"},"backfill-employee":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Backfill employee name","title":"ohana.common.schemas.public-api.scenario/backfill-employee","example":"John Smith"},"sub-team-employee":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Sub-team employee name","title":"ohana.common.schemas.public-api.scenario/sub-team-employee","example":"Bob Johnson"},"budget-impact":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Budget impact amount","title":"ohana.common.schemas.public-api.scenario/budget-impact","example":185000.0},"employee-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Employee name","title":"ohana.common.schemas.public-api.scenario/employee-name","example":"Jane Doe"},"job-role":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Job role","title":"ohana.common.schemas.public-api.scenario/job-role","example":"Engineer"},"target-impact":{"oneOf":[{"type":"number","format":"double"},{"type":"null"}],"description":"Target impact or target budget","title":"ohana.common.schemas.public-api.scenario/target-impact","example":190000.0},"equity-currency":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Currency for equity","title":"ohana.common.schemas.public-api.scenario/equity-currency","example":"USD"},"contract-end-date":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Contract end date if applicable","title":"ohana.common.schemas.public-api.scenario/contract-end-date","example":"2024-12-31T00:00:00Z"},"team":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Team name","title":"ohana.common.schemas.public-api.scenario/team","example":"Growth Team"},"initiative":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Initiative name","title":"ohana.common.schemas.public-api.scenario/initiative","example":"AI Platform"},"scenario-name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Name of the scenario","title":"ohana.common.schemas.public-api.scenario/scenario-name","example":"Annual Budget Plan"},"employment-end-date":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Employment end date","title":"ohana.common.schemas.public-api.scenario/employment-end-date","example":"2025-12-31T00:00:00Z"},"teamohana-id":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"TeamOhana Employee ID","title":"ohana.common.schemas.public-api.scenario/teamohana-id","example":"TO-5678"},"justification":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Justification for headcount","title":"ohana.common.schemas.public-api.scenario/justification","example":"New hire for Q4 expansion"}},"title":"ohana.common.schemas.public-api.scenario/export-row"},"description":"List of export records","example":[{"headcount-id":"GH-292","scenario-name":"Updating budget comp","pay-rate":"YEAR","department":"Account Management","entity-type":"headcount","variable":null,"equity":null,"contract-end-date":null,"remaining-budget":-231240.0,"job-id":"","division":"Sales","job-role":"Mid-Market Account Manager II","target-start-date":"2025-07-01T00:00:00Z","initiative":"Backfill (2025 Promo/Transfer)","employee-type":"Full time","job-title":"Mid-Market Account Manager II","target-base":103400.0,"scenario-id":"SC-7","teamohana-id":null,"target-impact":231240.0,"justification":"Deleted code is debugged code. -Jeff Sickel","team":"Sales","priority":"High","pay-currency":"USD","status":"Hired","budget-impact":0,"employee-name":null,"headcount-type":"Backfill","opening-id":"","target-variable":84600.0,"job-level":"P3","equity-currency":null,"target-equity":0.0,"base":null,"budget-type":"Budgeted","backfill-employee":"Fred Lakin","location":"United States of America","reporting-manager":"Alex Rogahn","hris-employee-id":null},{"headcount-id":"","scenario-name":"Updating budget comp","pay-rate":"YEAR","department":"Platform","entity-type":"employee","variable":10667.0,"equity":null,"contract-end-date":null,"remaining-budget":null,"job-id":"","division":"Engineering","job-role":null,"target-start-date":"2021-11-16T00:00:00Z","initiative":null,"employee-type":"Regular","job-title":"Senior Data Engineer II","target-base":null,"scenario-id":"SC-7","teamohana-id":"TO-1410","target-impact":null,"justification":null,"team":null,"priority":null,"pay-currency":"USD","status":null,"budget-impact":null,"employee-name":"Lecia Wolf","headcount-type":null,"opening-id":"","target-variable":null,"job-level":"P4","equity-currency":null,"target-equity":null,"base":191492.45,"budget-type":null,"backfill-employee":null,"location":"Distributed - TX","reporting-manager":"Zoraida Gleichner","hris-employee-id":"983"}],"title":"ohana.common.schemas.public-api.scenario/rows"}},"text/csv":{"schema":{"type":"string"}}}}},"tags":["Scenario"],"summary":"Fetch headcount and employees within the scenario","description":"Get a list of all headcount and employees within the scenario."}}}}