{"swagger":"2.0","basePath":"/api/v1","schemes":["https"],"securityDefinitions":{"basic_auth":{"type":"basic","description":"HTTP Basic Authentication Works over 'HTTPS'"}},"consumes":["application/json"],"produces":["application/json"],"paths":{"/jobs":{"get":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"200":{"description":"Paginated collection of jobs.","schema":{"type":"array","items":{"$ref":"#/definitions/Job"}}}},"summary":"Get Jobs","description":"Returns a paginated list of jobs. Optional \"page\" and \"per_page\" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.","tags":["Jobs"],"parameters":[{"name":"sort_by","in":"query","type":"string","description":"Optionally sort the job list. Allowed values are: archived_at, company, distribution_status, id, offlined_at, posted_at, site_id, status, title.","required":false},{"name":"search","in":"query","type":"string","description":"Optionally search jobs with a matching title.","required":false},{"name":"sites","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs under the given sites.","required":false},{"name":"tags","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs with the given tags.","required":false},{"name":"users","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs managed by users with the given ids.","required":false},{"name":"status","in":"query","type":"string","description":"Optionally limit the response to jobs with a given status. Allowed values are: online, offline, archived.","required":false},{"name":"page","in":"query","type":"string","description":"Optional. The page number of results. Default is 1.","required":false},{"name":"per_page","in":"query","type":"string","description":"Optional. The number of results per page. Default is 1000. Max is 1000.","required":false},{"name":"site_ids","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs by sites with the given ids.","required":false},{"name":"updated_after","in":"query","type":"string","description":"Optionally limit the response to jobs updated after given date/time. Can be used with `updated_before`.","required":false},{"name":"updated_before","in":"query","type":"string","description":"Optionally limit the response to jobs updated before given date/time. Can be used with `updated_after`.","required":false}]},"post":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"422":{"description":"Fields were invalid or missing.","schema":{"properties":{"errors":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","example":"can't be blank"}}}}}}},"201":{"description":"Created a new job.","schema":{"$ref":"#/definitions/Job"}}},"summary":"Create Job","description":"Allows you to create a new job.","tags":["Jobs"],"parameters":[{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateJobPayload"}}]}},"/users/{user_id}/jobs":{"get":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"200":{"description":"Paginated collection of jobs.","schema":{"type":"array","items":{"$ref":"#/definitions/Job"}}}},"summary":"Get Jobs","description":"Returns a paginated list of jobs. Optional \"page\" and \"per_page\" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.","tags":["Jobs"],"parameters":[{"name":"user_id","in":"path","type":"string","description":"The identifier of the associated user.","required":true},{"name":"sort_by","in":"query","type":"string","description":"Optionally sort the job list. Allowed values are: archived_at, company, distribution_status, id, offlined_at, posted_at, site_id, status, title.","required":false},{"name":"search","in":"query","type":"string","description":"Optionally search jobs with a matching title.","required":false},{"name":"sites","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs under the given sites.","required":false},{"name":"tags","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs with the given tags.","required":false},{"name":"users","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs managed by users with the given ids.","required":false},{"name":"status","in":"query","type":"string","description":"Optionally limit the response to jobs with a given status. Allowed values are: online, offline, archived.","required":false},{"name":"page","in":"query","type":"string","description":"Optional. The page number of results. Default is 1.","required":false},{"name":"per_page","in":"query","type":"string","description":"Optional. The number of results per page. Default is 1000. Max is 1000.","required":false},{"name":"site_ids","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs by sites with the given ids.","required":false},{"name":"updated_after","in":"query","type":"string","description":"Optionally limit the response to jobs updated after given date/time. Can be used with `updated_before`.","required":false},{"name":"updated_before","in":"query","type":"string","description":"Optionally limit the response to jobs updated before given date/time. Can be used with `updated_after`.","required":false}]}},"/companies/{company_id}/jobs":{"get":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"200":{"description":"Paginated collection of jobs.","schema":{"type":"array","items":{"$ref":"#/definitions/Job"}}}},"summary":"Get Jobs","description":"Returns a paginated list of jobs. Optional \"page\" and \"per_page\" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.","tags":["Jobs"],"parameters":[{"name":"company_id","in":"path","type":"string","description":"The identifier of the associated company.","required":true},{"name":"sort_by","in":"query","type":"string","description":"Optionally sort the job list. Allowed values are: archived_at, company, distribution_status, id, offlined_at, posted_at, site_id, status, title.","required":false},{"name":"search","in":"query","type":"string","description":"Optionally search jobs with a matching title.","required":false},{"name":"sites","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs under the given sites.","required":false},{"name":"tags","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs with the given tags.","required":false},{"name":"users","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs managed by users with the given ids.","required":false},{"name":"status","in":"query","type":"string","description":"Optionally limit the response to jobs with a given status. Allowed values are: online, offline, archived.","required":false},{"name":"page","in":"query","type":"string","description":"Optional. The page number of results. Default is 1.","required":false},{"name":"per_page","in":"query","type":"string","description":"Optional. The number of results per page. Default is 1000. Max is 1000.","required":false},{"name":"site_ids","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs by sites with the given ids.","required":false},{"name":"updated_after","in":"query","type":"string","description":"Optionally limit the response to jobs updated after given date/time. Can be used with `updated_before`.","required":false},{"name":"updated_before","in":"query","type":"string","description":"Optionally limit the response to jobs updated before given date/time. Can be used with `updated_after`.","required":false}]},"post":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"422":{"description":"Fields were invalid or missing.","schema":{"properties":{"errors":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","example":"can't be blank"}}}}}}},"201":{"description":"Created a new job.","schema":{"$ref":"#/definitions/Job"}}},"summary":"Create Job","description":"Allows you to create a new job.","tags":["Jobs"],"parameters":[{"name":"company_id","in":"path","type":"string","description":"The identifier of the associated company.","required":true},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateJobPayload"}}]}},"/sites/{site_id}/jobs":{"get":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"200":{"description":"Paginated collection of jobs.","schema":{"type":"array","items":{"$ref":"#/definitions/Job"}}}},"summary":"Get Jobs","description":"Returns a paginated list of jobs. Optional \"page\" and \"per_page\" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.","tags":["Jobs"],"parameters":[{"name":"site_id","in":"path","type":"string","description":"The identifier of the associated site.","required":true},{"name":"sort_by","in":"query","type":"string","description":"Optionally sort the job list. Allowed values are: archived_at, company, distribution_status, id, offlined_at, posted_at, site_id, status, title.","required":false},{"name":"search","in":"query","type":"string","description":"Optionally search jobs with a matching title.","required":false},{"name":"sites","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs under the given sites.","required":false},{"name":"tags","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs with the given tags.","required":false},{"name":"users","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs managed by users with the given ids.","required":false},{"name":"status","in":"query","type":"string","description":"Optionally limit the response to jobs with a given status. Allowed values are: online, offline, archived.","required":false},{"name":"page","in":"query","type":"string","description":"Optional. The page number of results. Default is 1.","required":false},{"name":"per_page","in":"query","type":"string","description":"Optional. The number of results per page. Default is 1000. Max is 1000.","required":false},{"name":"site_ids","in":"query","type":"array","items":{"type":"string"},"description":"Optionally limit the response to jobs by sites with the given ids.","required":false},{"name":"updated_after","in":"query","type":"string","description":"Optionally limit the response to jobs updated after given date/time. Can be used with `updated_before`.","required":false},{"name":"updated_before","in":"query","type":"string","description":"Optionally limit the response to jobs updated before given date/time. Can be used with `updated_after`.","required":false}]},"post":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"422":{"description":"Fields were invalid or missing.","schema":{"properties":{"errors":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","example":"can't be blank"}}}}}}},"201":{"description":"Created a new job.","schema":{"$ref":"#/definitions/Job"}}},"summary":"Create Job","description":"Allows you to create a new job.","tags":["Jobs"],"parameters":[{"name":"site_id","in":"path","type":"string","description":"The identifier of the associated site.","required":true},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateJobPayload"}}]}},"/jobs/{id}":{"get":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"200":{"description":"Returns a job.","schema":{"$ref":"#/definitions/Job"}}},"summary":"Get Job","description":"Returns a job.","tags":["Jobs"],"parameters":[{"name":"id","in":"path","type":"string","description":"The identifier provided after your job was created.","required":true}]},"put":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"422":{"description":"Fields were invalid or missing.","schema":{"properties":{"errors":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","example":"can't be blank"}}}}}}},"200":{"description":"Updated a job.","schema":{"$ref":"#/definitions/Job"}}},"summary":"Update Job","description":"Updates a job.","tags":["Jobs"],"parameters":[{"name":"id","in":"path","type":"string","description":"The identifier provided after the job was created.","required":true},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/PutJobPayload"}}]},"patch":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"422":{"description":"Fields were invalid or missing.","schema":{"properties":{"errors":{"type":"object","properties":{"field_name":{"type":"array","items":{"type":"string","example":"can't be blank"}}}}}}},"200":{"description":"Updated a job.","schema":{"$ref":"#/definitions/Job"}}},"summary":"Update Job","description":"Updates a job.","tags":["Jobs"],"parameters":[{"name":"id","in":"path","type":"string","description":"The identifier provided after the job was created.","required":true},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/PatchJobPayload"}}]},"delete":{"responses":{"403":{"description":"Not authorized"},"500":{"description":"Internal system error.  Please contact support in the event that this occurs."},"404":{"description":"Record not found.  Please check to make sure that the specified ID is valid."},"204":{"description":"Deleted the job. Returns an empty payload."}},"summary":"Delete Job","description":"Deletes a job.","tags":["Jobs"],"parameters":[{"name":"id","in":"path","type":"string","description":"The identifier provided after the job was created.","required":true}]}}},"definitions":{"Job":{"properties":{"id":{"type":"string","example":"1"},"company_id":{"type":"string","example":"1"},"hiring_entity_name":{"type":"string","example":"WidgetCo."},"site_id":{"type":"string","example":"1"},"location_id":{"type":"string","example":"1"},"title":{"type":"string","example":"Widget Maker"},"job_code":{"type":"string","example":"C104"},"external_id":{"type":"string","example":"abc123"},"status":{"type":"string","example":"online","enum":["online","offline","archived"]},"description":{"type":"string","example":"Responsible for \u003cb\u003eALL\u003c/b\u003e widget production."},"abstract":{"type":"string","example":"Master widget maker"},"category":{"type":"string","example":"Production Line"},"joblink":{"type":"string","example":"http://www.joblink.dev/a/1000"},"address":{"type":"string","example":"1 Main St."},"city":{"type":"string","example":"Philadelphia"},"state":{"type":"string","example":"PA"},"zipcode":{"type":"string","example":"19019"},"country":{"type":"string","example":"United States"},"visible":{"type":"boolean","example":true},"posted_at":{"type":"string","example":"2018-01-08T06:34:48-08:00"},"offlined_at":{"type":"string","example":"2018-01-08T06:34:48-08:00"},"archived_at":{"type":"string","example":"2018-01-08T06:34:48-08:00"},"unrated_apps":{"type":"integer","example":0},"total_apps":{"type":"integer","example":0},"open_positions_count":{"type":"integer","example":2},"tags":{"type":"array","example":["urgent"]},"remote":{"type":"boolean","example":true},"show_remote_in_location":{"type":"boolean","example":true},"allow_resume_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_resume_upload."},"require_resume_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_resume_upload is false."},"allow_coverletter_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_coverletter_upload."},"require_coverletter_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_coverletter_upload is false."},"keywords":{"type":"array","example":["widget"]},"supports_purchases":{"type":"boolean","example":true},"allow_free_syndication":{"type":"boolean","example":true},"allow_job_board_applications":{"type":"boolean","example":true},"free_syndicated":{"type":"boolean","example":true},"free_syndication_refreshed_at":{"type":"string","example":"2018-01-08T06:34:48-08:00"},"min_salary":{"type":"object","example":{"amount":"15.00","currency":"USD"}},"max_salary":{"type":"object","example":{"amount":"20.00","currency":"USD"}},"pay_frequency":{"type":"string","example":"hourly","enum":["hourly","weekly","monthly","annually"]},"workflow_status":{"type":"string","example":"active"},"applicant_sms_confirmation_template_id":{"type":"string","example":"1"},"applicant_email_confirmation_template_id":{"type":"string","example":"1"},"distribution_status":{"type":"string","example":"none","enum":["none","indeed_free","free_only","active"]},"locale_code":{"type":"string","example":"en"},"show_location":{"type":"boolean","example":true},"active_job_board_posting_count":{"type":"integer","example":7},"created_at":{"type":"string","example":"2018-01-08T06:34:48-08:00"},"updated_at":{"type":"string","example":"2018-01-08T06:34:48-08:00"},"assigned_user_ids":{"type":"array","example":["1","2"]}}},"CreateJobPayload":{"required":["title","city","state"],"properties":{"site_id":{"type":"string","example":"123"},"job_code":{"type":"string","example":"C104"},"external_id":{"type":"string","example":"abc123"},"title":{"type":"string","example":"Widget Maker"},"abstract":{"type":"string","example":"Master widget maker"},"description":{"type":"string","example":"Responsible for \u003cb\u003eALL\u003c/b\u003e widget production."},"job_description_template_id":{"type":"string","example":"456"},"status":{"type":"string","example":"online","enum":["online","offline","archived"]},"category":{"type":"string","example":"Production Line"},"address":{"type":"string","example":"1 Main St."},"city":{"type":"string","example":"Philadelphia"},"state":{"type":"string","example":"PA"},"zipcode":{"type":"string","example":"19019"},"country":{"type":"string","example":"United States"},"min_salary":{"type":"string","example":"150000.00"},"max_salary":{"type":"string","example":"200000.00"},"pay_frequency":{"type":"string","example":"monthly","enum":["hourly","weekly","monthly","annually"]},"tags":{"type":"array","example":["urgent"]},"remote":{"type":"boolean","example":true},"show_remote_in_location":{"type":"boolean","example":true},"allow_resume_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_resume_upload."},"require_resume_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_resume_upload is false."},"allow_coverletter_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_coverletter_upload."},"require_coverletter_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_coverletter_upload is false."},"keywords":{"type":"array","example":["widget"]},"open_positions_count":{"type":"integer","example":2},"allow_free_syndication":{"type":"boolean","example":true},"applicant_sms_confirmation_template_id":{"type":"string","example":"1"},"applicant_email_confirmation_template_id":{"type":"string","example":"1"},"show_location":{"type":"boolean","default":true,"example":true},"assigned_user_ids":{"type":"array","example":["1","2"]}}},"PutJobPayload":{"required":["title","description","city","state"],"properties":{"site_id":{"type":"string","example":"123"},"job_code":{"type":"string","example":"C104"},"external_id":{"type":"string","example":"abc123"},"title":{"type":"string","example":"Widget Maker"},"abstract":{"type":"string","example":"Master widget maker"},"description":{"type":"string","example":"Responsible for \u003cb\u003eALL\u003c/b\u003e widget production."},"status":{"type":"string","example":"online","enum":["online","offline","archived"]},"category":{"type":"string","example":"Production Line"},"address":{"type":"string","example":"1 Main St."},"city":{"type":"string","example":"Philadelphia"},"state":{"type":"string","example":"PA"},"zipcode":{"type":"string","example":"19019"},"country":{"type":"string","example":"United States"},"min_salary":{"type":"string","example":"150000.00"},"max_salary":{"type":"string","example":"200000.00"},"pay_frequency":{"type":"string","example":"monthly","enum":["hourly","weekly","monthly","annually"]},"tags":{"type":"array","example":["urgent"]},"remote":{"type":"boolean","example":true},"show_remote_in_location":{"type":"boolean","example":true},"allow_resume_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_resume_upload."},"require_resume_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_resume_upload is false."},"allow_coverletter_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_coverletter_upload."},"require_coverletter_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_coverletter_upload is false."},"keywords":{"type":"array","example":["widget"]},"open_positions_count":{"type":"integer","example":2},"allow_free_syndication":{"type":"boolean","example":true},"applicant_sms_confirmation_template_id":{"type":"string","example":"1"},"applicant_email_confirmation_template_id":{"type":"string","example":"1"},"location_id":{"type":"string","example":"123"},"assigned_user_ids":{"type":"array","example":["1","2"]},"scorecard_titles":{"type":"array","example":["Scorecard Title","Another Scorecard Title"]}}},"PatchJobPayload":{"properties":{"site_id":{"type":"string","example":"123"},"job_code":{"type":"string","example":"C104"},"external_id":{"type":"string","example":"abc123"},"title":{"type":"string","example":"Widget Maker"},"abstract":{"type":"string","example":"Master widget maker"},"description":{"type":"string","example":"Responsible for \u003cb\u003eALL\u003c/b\u003e widget production."},"status":{"type":"string","example":"online","enum":["online","offline","archived"]},"category":{"type":"string","example":"Production Line"},"address":{"type":"string","example":"1 Main St."},"city":{"type":"string","example":"Philadelphia"},"state":{"type":"string","example":"PA"},"zipcode":{"type":"string","example":"19019"},"country":{"type":"string","example":"United States"},"min_salary":{"type":"string","example":"150000.00"},"max_salary":{"type":"string","example":"200000.00"},"pay_frequency":{"type":"string","example":"monthly","enum":["hourly","weekly","monthly","annually"]},"tags":{"type":"array","example":["urgent"]},"remote":{"type":"boolean","example":true},"show_remote_in_location":{"type":"boolean","example":true},"allow_resume_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_resume_upload."},"require_resume_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_resume_upload is false."},"allow_coverletter_upload":{"type":"boolean","example":true,"description":"This parameter is implied by the presence of require_coverletter_upload."},"require_coverletter_upload":{"type":"boolean","example":true,"description":"Cannot be true if allow_coverletter_upload is false."},"keywords":{"type":"array","example":["widget"]},"open_positions_count":{"type":"integer","example":2},"allow_free_syndication":{"type":"boolean","example":true},"applicant_sms_confirmation_template_id":{"type":"string","example":"1"},"applicant_email_confirmation_template_id":{"type":"string","example":"1"},"location_id":{"type":"string","example":"123"},"assigned_user_ids":{"type":"array","example":["1","2"]},"scorecard_titles":{"type":"array","example":["Scorecard Title","Another Scorecard Title"]}}}},"host":"api.applicant-tracking.com","info":{"version":"1.0.0","title":"Applicant Tracking API","description":"Applicant Tracking API"}}