{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:homerun/job-applications-list-of-applications":{"get":{"operationId":"security_homerun_job_applications_list_of_applications","summary":"Get a list of job applications","description":"GET /job-applications","tags":["security"],"parameters":[{"name":"filter","in":"query","required":false,"description":"Filter by one of the fields","schema":{"type":"object","description":"Filter by one of the fields"}},{"name":"include","in":"query","required":false,"description":"Include additional information in the response","schema":{"type":"array","description":"Include additional information in the response"}},{"name":"page","in":"query","required":false,"description":"Change the page number to get more results","schema":{"type":"integer","default":1,"description":"Change the page number to get more results"}},{"name":"perPage","in":"query","required":false,"description":"Change the number of object returned per page","schema":{"type":"integer","default":15,"description":"Change the number of object returned per page"}}],"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/security:homerun/job-applications-add-new-application":{"post":{"operationId":"security_homerun_job_applications_add_new_application","summary":"Create new job applications","description":"POST /job-applications","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/security:homerun/job-applications-detailed-info":{"get":{"operationId":"security_homerun_job_applications_detailed_info","summary":"Get detailed information of a job application","description":"GET /job-applications/{job_application_id}","tags":["security"],"parameters":[{"name":"job_application_id","in":"query","required":true,"description":"Job Application ID","schema":{"type":"string","description":"Job Application ID"},"example":"ap_D3kCkoClbG6n6KlqD0ob"},{"name":"include","in":"query","required":false,"description":"Include additional information in the response","schema":{"type":"array","description":"Include additional information in the response"}}],"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/security:homerun/job-applications-update-properties":{"post":{"operationId":"security_homerun_job_applications_update_properties","summary":"Update job application properties","description":"PATCH /job-applications/{job_application_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job_application_id","body"],"properties":{"job_application_id":{"type":"string","description":"Job Application 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/security:homerun/job-applications-remove-job-app":{"post":{"operationId":"security_homerun_job_applications_remove_job_app","summary":"Delete a job application","description":"DELETE /job-applications/{job_application_id}","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job_application_id"],"properties":{"job_application_id":{"type":"string","description":"Job Application 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/security:homerun/job-application-notes-create-new-note":{"post":{"operationId":"security_homerun_job_application_notes_create_new_note","summary":"Create a new note","description":"POST /job-applications/{job_application_id}/notes","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job_application_id","body"],"properties":{"job_application_id":{"type":"string","description":"Job Application 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/security:homerun/job-application-files-upload-files-to-job-application":{"post":{"operationId":"security_homerun_job_application_files_upload_files_to_job_application","summary":"Upload files to a job application","description":"POST /job-applications/{job_application_id}/files","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job_application_id","body"],"properties":{"job_application_id":{"type":"string","description":"Job Application ID"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/security:homerun/job-application-files-upload-photo":{"post":{"operationId":"security_homerun_job_application_files_upload_photo","summary":"Upload an applicant photo","description":"POST /job-applications/{job_application_id}/photo","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job_application_id","body"],"properties":{"job_application_id":{"type":"string","description":"Job Application ID"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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/security:homerun/vacancies-list-of-vacancies":{"get":{"operationId":"security_homerun_vacancies_list_of_vacancies","summary":"Get a list of vacancies","description":"GET /vacancies","tags":["security"],"parameters":[{"name":"filter","in":"query","required":false,"description":"Name of the vacancy status","schema":{"type":"object","description":"Name of the vacancy status"}},{"name":"include","in":"query","required":false,"description":"Include additional information in the response","schema":{"type":"array","description":"Include additional information in the response"}},{"name":"page","in":"query","required":false,"description":"Change the page number to get more results","schema":{"type":"integer","default":1,"description":"Change the page number to get more results"}},{"name":"perPage","in":"query","required":false,"description":"Change the number of object returned per page","schema":{"type":"integer","default":15,"description":"Change the number of object returned per page"}}],"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/security:homerun/vacancies-detailed-info":{"get":{"operationId":"security_homerun_vacancies_detailed_info","summary":"Get detailed information of a vacancy","description":"GET /vacancies/{vacancy_id}","tags":["security"],"parameters":[{"name":"vacancy_id","in":"query","required":true,"description":"Vacancy ID","schema":{"type":"string","description":"Vacancy ID"},"example":"job_SnhUsAg1QwTRFIRNUfM6"},{"name":"include","in":"query","required":false,"description":"Include additional information in the response","schema":{"type":"array","description":"Include additional information in the response"}}],"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/security:homerun/other-dummy-endpoint":{"get":{"operationId":"security_homerun_other_dummy_endpoint","summary":"Dummy endpoint for testing authentication","description":"GET /ping","tags":["security"],"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"}}},"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"}}}}}}}