{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:breezy-hr/authentication-get-access-token":{"post":{"operationId":"business_breezy_hr_authentication_get_access_token","summary":"/signin","description":"POST /v3/signin","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/session-invalidate-token":{"get":{"operationId":"business_breezy_hr_session_invalidate_token","summary":"/signout","description":"GET /v3/signout","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/user-get-by-id":{"get":{"operationId":"business_breezy_hr_user_get_by_id","summary":"/user","description":"GET /v3/user","tags":["business"],"parameters":[{"name":"user_id","in":"query","required":false,"description":"user id to lookup (if blank look up by auth token)","schema":{"type":"string","description":"user id to lookup (if blank look up by auth token)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/user-get-company-details":{"get":{"operationId":"business_breezy_hr_user_get_company_details","summary":"/user/details","description":"GET /v3/user/details","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-information":{"get":{"operationId":"business_breezy_hr_company_get_information","summary":"/company/:id/","description":"GET /v3/company/{company_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-candidate-custom-attributes":{"get":{"operationId":"business_breezy_hr_company_get_candidate_custom_attributes","summary":"/company/:id/custom-attributes/candidate","description":"GET /v3/company/{company_id}/custom-attributes/candidate","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-custom-attributes":{"get":{"operationId":"business_breezy_hr_company_get_position_custom_attributes","summary":"/company/:id/custom-attributes/position","description":"GET /v3/company/{company_id}/custom-attributes/position","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-pipeline-stages-by-pipeline-id":{"get":{"operationId":"business_breezy_hr_company_get_pipeline_stages_by_pipeline_id","summary":"/company/:id/pipeline/:id","description":"GET /v3/company/{company_id}/pipeline/{pipeline_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"pipeline_id","in":"query","required":true,"description":"pipeline id","schema":{"type":"string","description":"pipeline id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-pipelines":{"get":{"operationId":"business_breezy_hr_company_get_pipelines","summary":"/company/:id/pipelines","description":"GET /v3/company/{company_id}/pipelines","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-questionnaire-by-id":{"get":{"operationId":"business_breezy_hr_company_get_questionnaire_by_id","summary":"/company/:id/questionnaire/:id","description":"GET /v3/company/{company_id}/questionnaire/{questionnaire_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"questionnaire_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-questionnaires":{"get":{"operationId":"business_breezy_hr_company_get_questionnaires","summary":"/company/:id/questionnaires","description":"GET /v3/company/{company_id}/questionnaires","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-email-template-by-id":{"get":{"operationId":"business_breezy_hr_company_get_email_template_by_id","summary":"/company/:id/template/:id","description":"GET /v3/company/{company_id}/template/{template_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"template_id","in":"query","required":true,"description":"template id","schema":{"type":"string","description":"template id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-all-templates":{"get":{"operationId":"business_breezy_hr_company_get_all_templates","summary":"/company/:id/templates","description":"GET /v3/company/{company_id}/templates","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-associated":{"get":{"operationId":"business_breezy_hr_company_get_associated","summary":"/companies","description":"GET /v3/companies","tags":["business"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-details":{"get":{"operationId":"business_breezy_hr_company_get_position_details","summary":"./position/:id","description":"GET /v3/company/{company_id}/position/{position_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-update-position-details":{"post":{"operationId":"business_breezy_hr_company_update_position_details","summary":"./position/:id","description":"PUT /v3/company/{company_id}/position/{position_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-update-position-state":{"post":{"operationId":"business_breezy_hr_company_update_position_state","summary":"./position/:id/state","description":"PUT /v3/company/{company_id}/position/{position_id}/state","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-stream":{"get":{"operationId":"business_breezy_hr_company_get_position_stream","summary":"./position/:id/stream","description":"GET /v3/company/{company_id}/position/{position_id}/stream","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company","schema":{"type":"string","description":"company"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-team-members":{"get":{"operationId":"business_breezy_hr_company_get_position_team_members","summary":"./position/:id/team","description":"GET /v3/company/{company_id}/position/{position_id}/team","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-positions-by-state":{"get":{"operationId":"business_breezy_hr_company_get_positions_by_state","summary":"./positions","description":"GET /v3/company/{company_id}/positions","tags":["business"],"parameters":[{"name":"state","in":"query","required":false,"description":"Specify an optional position state filter. e.g. draft, archived, published, closed, pending","schema":{"type":"string","default":"published","description":"Specify an optional position state filter. e.g. draft, archived, published, closed, pending"}},{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-create-new-position":{"post":{"operationId":"business_breezy_hr_company_create_new_position","summary":"./positions","description":"POST /v3/company/{company_id}/positions","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id"],"properties":{"company_id":{"type":"string","description":"company id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-custom-fields":{"get":{"operationId":"business_breezy_hr_company_get_position_custom_fields","summary":"./position/:id/custom-fields","description":"GET /v3/company/{company_id}/position/{position_id}/custom-fields","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-update-custom-field":{"post":{"operationId":"business_breezy_hr_company_update_custom_field","summary":"./position/:id/custom-fields/:id","description":"PUT /v3/company/{company_id}/position/{position_id}/custom-fields/{custom_field_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","custom_field_id"],"properties":{"company_id":{"type":"string","description":"company id"},"position_id":{"type":"string","description":"position id"},"custom_field_id":{"type":"string","description":"custom field id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-candidate-by-id":{"get":{"operationId":"business_breezy_hr_company_get_candidate_by_id","summary":"./candidate/:id","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}},{"name":"candidate_id","in":"query","required":true,"description":"candidate id","schema":{"type":"string","description":"candidate id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-update-candidate-position":{"post":{"operationId":"business_breezy_hr_company_update_candidate_position","summary":"./candidate/:id","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-assessments":{"get":{"operationId":"business_breezy_hr_company_get_assessments","summary":"./candidate/:id/assessments","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/assessments","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}},{"name":"candidate_id","in":"query","required":true,"description":"candidate id","schema":{"type":"string","description":"candidate id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/background-check-get-all":{"get":{"operationId":"business_breezy_hr_background_check_get_all","summary":"./candidate/:id/background-checks","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/background-checks","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}},{"name":"candidate_id","in":"query","required":true,"description":"candidate id","schema":{"type":"string","description":"candidate id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/conversation-get-stream":{"get":{"operationId":"business_breezy_hr_conversation_get_stream","summary":"./candidate/:id/conversation","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/conversation","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company _id","schema":{"type":"string","description":"company _id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}},{"name":"candidate_id","in":"query","required":true,"description":"candidate id","schema":{"type":"string","description":"candidate id"}},{"name":"include_delayed","in":"query","required":false,"description":"1 to include any messages that are currently queued for delayed delivery","schema":{"type":"integer","default":0,"description":"1 to include any messages that are currently queued for delayed delivery"}},{"name":"skip","in":"query","required":false,"description":"Number of records to skip for paging","schema":{"type":"integer","default":0,"description":"Number of records to skip for paging"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/conversation-add-message":{"post":{"operationId":"business_breezy_hr_conversation_add_message","summary":"./candidate/:id/conversation","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/conversation","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/custom-attribute-add-to-candidate-custom-attribute":{"post":{"operationId":"business_breezy_hr_custom_attribute_add_to_candidate_custom_attribute","summary":"./candidate/:id/custom-attribute","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-attribute","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-candidate-documents-by-position":{"get":{"operationId":"business_breezy_hr_company_get_candidate_documents_by_position","summary":"./candidate/:id/documents","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/documents","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"position_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"candidate_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-add-candidate-document":{"post":{"operationId":"business_breezy_hr_company_add_candidate_document","summary":"./candidate/:id/documents","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/documents","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-add-education-entry":{"post":{"operationId":"business_breezy_hr_company_add_education_entry","summary":"./candidate/:id/education","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/education","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-candidate-meta":{"get":{"operationId":"business_breezy_hr_company_get_position_candidate_meta","summary":"./candidate/:id/meta","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/meta","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"position_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"candidate_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-move-candidate-to-position":{"post":{"operationId":"business_breezy_hr_company_move_candidate_to_position","summary":"./candidate/:id/move","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/move","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/questionnaire-save-candidate-responses":{"post":{"operationId":"business_breezy_hr_questionnaire_save_candidate_responses","summary":"./candidate/:id/questionnaire/:id","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaire/{candidate_questionnaire_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id","candidate_questionnaire_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"candidate_questionnaire_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/questionnaire-get":{"get":{"operationId":"business_breezy_hr_questionnaire_get","summary":"./candidate/:id/questionnaires","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaires","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"position_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"candidate_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-attach-resume":{"post":{"operationId":"business_breezy_hr_company_attach_resume","summary":"./candidate/:id/resume","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/resume","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-update-candidate-scorecard":{"post":{"operationId":"business_breezy_hr_company_update_candidate_scorecard","summary":"./candidate/:id/scorecard","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/scorecard","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/questionnaire-create-for-candidate":{"post":{"operationId":"business_breezy_hr_questionnaire_create_for_candidate","summary":"./candidate/:id/send-questionnaire","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/send-questionnaire","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id","questionnaire_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"questionnaire_id":{"type":"string"},"email_candidate":{"type":"boolean","default":false,"description":"should the result of this action send an email to the candidate to complete questionnaire"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-move-candidate-stage":{"post":{"operationId":"business_breezy_hr_company_move_candidate_stage","summary":"./candidate/:id/stage","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stage","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-candidate-stream-events":{"get":{"operationId":"business_breezy_hr_company_get_position_candidate_stream_events","summary":"./candidate/:id/stream","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stream","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"position_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"candidate_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-add-candidate-stream-note":{"post":{"operationId":"business_breezy_hr_company_add_candidate_stream_note","summary":"./candidate/:id/stream","description":"POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stream","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/work-history-add-entry":{"post":{"operationId":"business_breezy_hr_work_history_add_entry","summary":"./candidate/:id/work-history","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/work-history","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"candidate_id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-position-candidates":{"get":{"operationId":"business_breezy_hr_company_get_position_candidates","summary":"./candidates","description":"GET /v3/company/{company_id}/position/{position_id}/candidates","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"position_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"page_size","in":"query","required":false,"description":"Add this parameter to force paging of results (max: 50)","schema":{"type":"integer","description":"Add this parameter to force paging of results (max: 50)"}},{"name":"page","in":"query","required":false,"description":"If page size is passed, this determines which page of data will be returned","schema":{"type":"integer","default":1,"description":"If page size is passed, this determines which page of data will be returned"}},{"name":"sort","in":"query","required":false,"description":"Determines the sort order of the data returned. Can be (created | updated)","schema":{"type":"string","default":"updated","description":"Determines the sort order of the data returned. Can be (created | updated)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-add-new-candidate-to-position":{"post":{"operationId":"business_breezy_hr_company_add_new_candidate_to_position","summary":"./candidates","description":"POST /v3/company/{company_id}/position/{position_id}/candidates","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"stage_actions_enabled":{"type":"boolean","default":false,"description":"When origin is \"sourced\", should stage actions be executed (defaults to false). This is always true when origin is \"applied\""},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-upload-resume":{"post":{"operationId":"business_breezy_hr_company_upload_resume","summary":"./candidates/resume","description":"POST /v3/company/{company_id}/position/{position_id}/candidates/resume","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id"],"properties":{"company_id":{"type":"string"},"position_id":{"type":"string"},"stage_id":{"type":"string","default":"applied","description":"id of pipeline stage to put new candidate in"},"stage_actions_enabled":{"type":"boolean","default":false,"description":"execute stage actions configured on stage candidate is being created in"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/company-get-candidates-by-email":{"get":{"operationId":"business_breezy_hr_company_get_candidates_by_email","summary":"./candidates/search","description":"GET /v3/company/{company_id}/candidates/search","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"email_address","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/custom-field-get":{"get":{"operationId":"business_breezy_hr_custom_field_get","summary":"./candidate/:id/custom-fields","description":"GET /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-fields","tags":["business"],"parameters":[{"name":"company_id","in":"query","required":true,"description":"company id","schema":{"type":"string","description":"company id"}},{"name":"position_id","in":"query","required":true,"description":"position id","schema":{"type":"string","description":"position id"}},{"name":"candidate_id","in":"query","required":true,"description":"candidate id","schema":{"type":"string","description":"candidate id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:breezy-hr/custom-field-update-candidate-custom-fields":{"post":{"operationId":"business_breezy_hr_custom_field_update_candidate_custom_fields","summary":"./candidate/:id/custom-fields/:id","description":"PUT /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-fields/{custom_field_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["company_id","position_id","candidate_id","custom_field_id"],"properties":{"company_id":{"type":"string","description":"company id"},"position_id":{"type":"string","description":"position id"},"candidate_id":{"type":"string","description":"candidate id"},"custom_field_id":{"type":"string","description":"custom field id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}