Breezy API Integration

These are the list of integration use cases supported by Knit for Breezy API as part of the ATS category

Retrieve all 3rd party background checks for candidate

ID: get_all_3rd_party_background_checks_for_candidate
Operation: read
Entities: position, candidate, background check
Summary: This API endpoint retrieves all 3rd party background checks for a specific candidate. It requires the company ID, position ID, and candidate ID as path parameters, and an API key for authorization in the headers. The response can be a successful background check object, or an error message if the access token is missing, invalid, or if there is an unknown internal error.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Candidates for Published Positions of a Company

ID: get_all_job_applications
Operation: read
Entities:
Summary: This configuration retrieves all candidates for all published positions of a given company. It first retrieves all positions in the 'published' state using the 'Retrieve All Positions for a Given Company in a Given State' API. For each position, it then retrieves the candidates using the 'Retrieve Candidates for Given Position' API. The input requires an API key for authorization and the company ID as a path parameter. Optional query parameters include page size, page number, and sort order. The output is a list of candidates with details such as ID, creation date, email, name, origin, phone number, profile photo URL, resume details, source, stage, tags, and updated date.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All Positions for a Given Company in a Given State

ID: get_all_positions_for_given_company_in_given_state
Operation: read
Entities: position, company, state
Summary: This API retrieves all positions for a given company in a specified state. The request requires an Authorization header with an API key and a path parameter for the company_id. An optional query parameter 'state' can be used to filter positions by their state, such as draft, archived, published, closed, or pending. The response includes a list of position objects if successful (HTTP 200). Each position object contains detailed information such as type, state, name, location, education, department, and more. Error responses include HTTP 400 for missing access token, HTTP 401 for invalid access token, and HTTP 500 for unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate by ID for Given Position

ID: get_candidate_by_id_for_given_position
Operation: read
Entities: position, company, candidate
Summary: This API retrieves a candidate by their ID for a given position within a company. It requires the company ID, position ID, and candidate ID as path parameters, and an API key for authorization in the headers. The API returns a Candidate Object on success (HTTP 200). If the access token is missing or invalid, it returns an error with HTTP 400 or 401 respectively. An unknown internal error results in an HTTP 500 response.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate Conversation Stream

ID: get_candidate_conversation_stream
Operation: read
Entities: company, candidate, conversation
Summary: This API retrieves the conversation stream for a specific candidate within a company and position. It requires the company_id, position_id, and candidate_id as path parameters, and an API key for authorization. Optional query parameters include 'include_delayed' to include messages queued for delayed delivery and 'skip' for paging. The response includes an array of messages with details such as message type, body, subject, attachments, and timestamps. Error responses include missing or invalid access tokens and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get Candidate Custom Fields

ID: get_candidate_custom_fields
Operation: read
Entities: company, custom field, candidate
Summary: This API endpoint retrieves custom fields for a specific candidate within a company and position. It requires the company_id, position_id, and candidate_id as path parameters, and an Authorization header with a valid API key. The response can be a list of candidate custom field objects if successful (HTTP 200), or an error message if there is a missing or invalid access token (HTTP 400 or 401), or an unknown internal error (HTTP 500).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate Documents by ID for Given Position

ID: get_candidate_documents_by_id
Operation: read
Entities: position, company, candidate
Summary: This API retrieves documents associated with a specific candidate for a given position within a company. It requires the company ID, position ID, and candidate ID as path parameters, and an API key for authorization in the headers. The response includes a list of documents with details such as document ID, file name, file URL, file size, and creation date. Possible error responses include missing or invalid access tokens and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate Meta Data by ID for Given Position

ID: get_candidate_meta_data_by_id_for_given_position
Operation: read
Entities: position, company, candidate
Summary: This API retrieves the meta data of a candidate by their ID for a given position within a company. It requires the company ID, position ID, and candidate ID as path parameters, and an API key for authorization in the headers. The response includes various details about the candidate such as tasks, background checks, notes, assessments, and more. In case of errors, it returns appropriate error messages with status codes 400, 401, or 500.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate Specific Custom Attributes

ID: get_candidate_specific_custom_attributes
Operation: read
Entities: custom attribute, company, candidate
Summary: This API endpoint retrieves all candidate-specific custom attributes for a given company. The request requires an API key for authorization and the company ID as a path parameter. The response includes an array of custom attributes, each with an ID, name, and a boolean indicating if it is secure. Possible error responses include missing or invalid access tokens and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate's 3rd Party Assessments

ID: get_candidates_3rd_party_assessments
Operation: read
Entities: position, assessment, candidate
Summary: This API retrieves all 3rd party assessments that a candidate has taken for a specific position within a company. It requires the company_id, position_id, and candidate_id as path parameters, and an API key for authorization in the headers. The response can be a successful retrieval of the assessment object, or an error message if the access token is missing, invalid, or if there is an unknown internal error.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidates by Email Address

ID: get_candidates_by_email_address
Operation: read
Entities: position, company, candidate
Summary: This API retrieves all candidates associated with a specified email address for a given company. It requires an API key for authorization, a company ID as a path parameter, and an email address as a query parameter. The response includes a list of candidates with their IDs, names, and positions if successful. Error responses include missing or invalid access tokens, missing email addresses, or unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidates for Given Position

ID: get_candidates_for_given_position
Operation: read
Entities: position, company, candidate
Summary: This API retrieves candidates for a given position with an abbreviated candidate object. It requires the company ID and position ID as path parameters and an API key for authorization. Optional query parameters include page size, page number, and sort order. The response includes a list of candidates with details such as ID, creation date, email, name, origin, phone number, profile photo URL, resume details, source, stage, tags, and updated date. Error responses include missing or invalid access token and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Companies Associated with Authenticated User

ID: get_companies_associated_with_authenticated_user
Operation: read
Entities: user, company
Summary: This API retrieves the list of companies associated with the authenticated user. It requires an API key for authorization, which must be included in the request headers. The endpoint returns a list of company objects if successful. If the access token is missing or invalid, it returns an error with code 400 or 401, respectively. An unknown internal error will result in a 500 error code.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Company Questionnaires

ID: get_company_questionnaires
Operation: read
Entities: company, questionnaire
Summary: This API endpoint retrieves all questionnaires for a specified company. It requires an API key for authorization, which must be included in the headers. The company_id is a required path parameter that specifies the company whose questionnaires are to be retrieved. The response can be a list of questionnaire objects if successful (HTTP 200), or an error message if there is a missing or invalid access token (HTTP 400 or 401), or an unknown internal error (HTTP 500).
Input Fields: Input Fields
Output Fields: Output Fields

Invalidate Access Token

ID: get_invalidate_access_token
Operation: write
Entities: token, authentication
Summary: This API endpoint is used to invalidate an access token. It requires a GET request to the URL 'https://api.breezy.hr/v3/signout'. The request must include an 'Authorization' header with the API key, which is required. Upon successful request, the API returns a 204 status code indicating that the token has been invalidated. There is no response body or additional headers returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Last 30 Activity Stream Events for a Position

ID: get_last_30_activity_stream_events_for_a_position
Operation: read
Entities: position, activity stream event, company
Summary: This API retrieves the last 30 activity stream events for a specified position within a company. It requires the company_id and position_id as path parameters, and an Authorization header with a valid API key. The response includes an array of event objects, each containing an _id, type, stream_id, object, and timestamp. If the access token is missing, a 400 error with a specific message is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Last 50 Candidate Discussion Stream Events

ID: get_last_50_candidate_discussion_stream_events
Operation: read
Entities: position, company, candidate
Summary: This API retrieves the last 50 candidate discussion stream events by candidate id for a given position. It requires the company_id, position_id, and candidate_id as path parameters, and an Authorization header with the API key. The stage_id can be optionally provided in the body to specify the pipeline stage for the candidate. The API returns a 204 status code on success, and various error messages for missing or invalid access tokens, missing stage_id, or internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Pipeline Stages by Pipeline ID

ID: get_pipeline_stages_by_pipeline_id
Operation: read
Entities: company, stage, pipeline
Summary: This API retrieves all stages of a specific pipeline by its ID for a given company. The request requires an API key for authorization, and both the company ID and pipeline ID must be provided as path parameters. The response includes an array of stages, each with details such as stage ID, name, icon, action count, actions, type, and action. Possible error responses include missing or invalid access tokens and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Get Position Custom Fields

ID: get_position_custom_fields
Operation: read
Entities: position, company, custom field
Summary: The Get Position Custom Fields API retrieves custom fields for a specific position within a company. It requires the company_id and position_id as path parameters and an Authorization header with a valid API key. The response can be a list of custom field objects if successful (HTTP 200), or an error message if there are issues such as missing or invalid access tokens (HTTP 400 or 401) or internal server errors (HTTP 500).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Position Details

ID: get_position_details
Operation: read
Entities: position, company
Summary: This API retrieves the details of a specific position using the provided position ID and company ID. The request requires an Authorization header with a valid API key. The path parameters include 'company_id' and 'position_id', both of which are required. The response can be a successful Position Object (HTTP 200), which includes details such as position type, state, name, location, education, department, and more. Alternatively, it can return an error message if the access token is missing (HTTP 400), invalid (HTTP 401), or if there is an unknown internal error (HTTP 500).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Position Specific Custom Attributes

ID: get_position_specific_custom_attributes
Operation: read
Entities: custom attribute, company, position
Summary: This API endpoint retrieves all position-specific custom attributes for a given company. It requires an API key for authorization, which should be included in the request headers. The company ID must be provided as a path parameter. On success, it returns a list of custom attributes, each with an ID, name, and a boolean indicating if it is secure. Possible error responses include missing or invalid access tokens, and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Questionnaire by ID

ID: get_questionnaire_by_id
Operation: read
Entities: company, questionnaire
Summary: This API retrieves a questionnaire by its ID for a specific company. It requires an API key for authorization, which must be included in the headers. The company_id and questionnaire_id are required path parameters. The API returns a Questionnaire Object on success (HTTP 200). If the access token is missing or invalid, it returns an error with HTTP 400 or 401 respectively. An unknown internal error results in an HTTP 500 response.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate Questionnaires

ID: get_retrieve_candidate_questionnaires
Operation: read
Entities: position, candidate, questionnaire
Summary: This API retrieves the questionnaires associated with a specific candidate for a given position within a company. It requires the company_id, position_id, and candidate_id as path parameters, and an Authorization header containing the API key. The response can be a list of CandidateQuestionnaire objects if successful (HTTP 200), or an error message if there is a missing or invalid access token (HTTP 400 or 401), or an unknown internal error (HTTP 500).
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Company Email Templates

ID: get_retrieve_company_email_templates
Operation: read
Entities: template, company, error
Summary: This API retrieves all email templates for a specified company. It requires an API key for authorization, which must be included in the request headers. The company_id is a required path parameter that specifies the company whose templates are being retrieved. The API returns a list of template objects on success. If the access token is missing or invalid, it returns an error with code 400 or 401, respectively. An unknown internal error will result in a 500 error code.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Company Information

ID: get_retrieve_company_information
Operation: read
Entities: company
Summary: This API retrieves the company information associated with the authenticated user and the specified company ID. It requires an API key to be passed in the Authorization header and the company ID as a path parameter. The response can be a successful Company Object if the request is valid, or an error message if there are issues such as a missing or invalid access token, or an unknown internal error.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Email Template by ID

ID: get_retrieve_email_template_by_id
Operation: read
Entities: company, email template
Summary: This API retrieves an email template by its ID for a specific company. It requires an API key for authorization, which must be included in the headers. The company_id and template_id are required path parameters. The API returns a Template Object on success (HTTP 200). If the access token is missing or invalid, it returns an error with HTTP 400 or 401 respectively. An unknown internal error results in an HTTP 500 response.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Company Configuration Details

ID: get_user_company_configuration_details
Operation: read
Entities: user, company, configuration
Summary: This API retrieves the configuration details for each company the authenticated user belongs to. The request requires an API key for authorization, which should be included in the headers. The response includes detailed information about the company, messaging templates, reasons, questionnaires, pipelines, interview guides, templates, tasks, scorecards, user settings, positions, and members. The API returns various error codes for missing access tokens, user not found, invalid access tokens, and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Information

ID: get_user_information
Operation: read
Entities: user
Summary: This API retrieves the authenticated user or another user by their ID. It requires an Authorization header with an API key. Optionally, a user_id can be provided as a query parameter to look up a specific user. If the user_id is not provided, the API will look up the user based on the authentication token. The API returns a User object on success (HTTP 200). If the access token is missing or invalid, it returns an error with HTTP 400 or 401 respectively. If the user is not found, it returns an error with HTTP 404. For unknown internal errors, it returns an error with HTTP 500.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve User Objects of All Position Team Members

ID: get_user_objects_of_all_position_team_members
Operation: read
Entities: position, company, user
Summary: This API retrieves user objects of all team members associated with a specific position within a company. It requires the company ID and position ID as path parameters and an API key for authorization in the headers. The response includes details about each team member, such as their ID, email address, name, username, initial, creation date, email verification status, timezone offset, signature details, last updated date, and user role. Possible error responses include missing or invalid access tokens and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve All jobs present in the system.

ID: list_all_jobs
Operation: read
Entities:
Summary: This API retrieves all positions for a given company for all possible states.
Input Fields: Input Fields
Output Fields: Output Fields

Add a New Candidate to a Position

ID: post_add_new_candidate_to_a_position
Operation: write
Entities: position, company, candidate
Summary: This API endpoint allows you to add a new candidate to a specific position within a company. It requires the company ID and position ID as path parameters, and an API key for authorization. The request body must include the candidate's name and optionally other details such as email address, phone number, address, summary, tags, origin, source, work history, education, custom attributes, and cover letter. The API can return various responses, including a successful candidate object, a partial candidate creation notice, or error messages for missing or invalid access tokens, missing required fields, or internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Add New Conversation Message for Candidate

ID: post_add_new_conversation_message_for_candidate
Operation: write
Entities: company, candidate, conversation
Summary: This API endpoint allows you to add a new conversation message for a candidate. It requires an API key for authorization and the company_id, position_id, and candidate_id as path parameters. The body of the request contains the content of the conversation message. On success, it returns a message object with details such as the message body, subject, attachments, candidate_id, company_id, position_id, acting user, and timestamp. Possible error responses include missing body (400), invalid access token (401), and unknown internal error (500).
Input Fields: Input Fields
Output Fields: Output Fields

Add New Document for Candidate

ID: post_add_new_document_for_candidate
Operation: write
Entities: user, document, candidate
Summary: This API endpoint allows you to add a new document for a candidate in a specific position within a company. The request requires an Authorization header with an API key, and path parameters for company_id, position_id, and candidate_id. The document file is uploaded as form data. On success, it returns details of the uploaded document including its ID, file name, URL, size, and creation date. Possible error responses include missing or invalid access token (400, 401) and unknown internal errors (500).
Input Fields: Input Fields
Output Fields: Output Fields

Add Note to Candidate's Discussion Stream

ID: post_add_note_to_candidate_discussion_stream
Operation: write
Entities: company, note, candidate
Summary: This API adds a note to a candidate's discussion stream in Breezy HR. It requires an API key for authorization and the company, position, and candidate IDs as path parameters. The body of the request contains the content of the note to be added. On success, it returns the ID, type, stream ID, and timestamp of the note. Possible error responses include missing or invalid access token, missing body content, and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Attach a Resume File to an Existing Candidate

ID: post_attach_resume_file_to_existing_candidate
Operation: write
Entities: Position, Company, Candidate
Summary: This API endpoint allows you to attach a resume file to an existing candidate in a specific position within a company. The request requires an API key for authorization, and the company_id, position_id, and candidate_id must be specified as path parameters. The resume file must be sent as form-data with the field name 'file'. On success, the API returns a 204 status code. If the access token is missing or invalid, it returns a 400 or 401 error with a descriptive message. An internal server error during the upload process will result in a 500 error.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Position

ID: post_create_new_position
Operation: write
Entities: position, company, department
Summary: The 'Create a New Position' API allows users to create a new job position within a specified company. The API requires an Authorization header with an API key and a path parameter for the company ID. The request body must include the name, description, and type of the position, with optional fields for department, requisition ID, category, experience, education, custom attributes, pipeline ID, scorecard ID, questionnaire ID, and tags. The response will include a Position Object on success or an error message if there is an issue, such as a missing access token or required field.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Questionnaire for a Candidate

ID: post_create_new_questionnaire_for_candidate
Operation: write
Entities: position, company, candidate
Summary: This API endpoint allows the creation of a new questionnaire for a candidate. It requires the company_id, position_id, and candidate_id as path parameters, and the questionnaire_id as a query parameter. The Authorization header with a valid API key is required. Optionally, the email_candidate query parameter can be used to specify if an email should be sent to the candidate. On success, it returns a 204 status code with a CandidateQuestionnaire object. Possible error responses include missing or invalid access tokens, missing questionnaire_id, and unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Access Token

ID: post_retrieve_access_token
Operation: write
Entities: user, access token, error
Summary: This API endpoint is used to retrieve an access token for a user session. The request must include the user's email and password in the body as JSON. The 'Content-Type' header must be set to 'application/json'. On success, it returns a 200 status code with an access token and user details. If the email or password is missing, a 400 error is returned with a specific error message. If the email or password is incorrect, a 401 error is returned. An unknown internal error will result in a 500 error.
Input Fields: Input Fields
Output Fields: Output Fields

Retrieve Candidate Meta Data by ID for Given Position

ID: post_retrieve_candidate_meta_data
Operation: write
Entities: position, company, candidate
Summary: This API retrieves candidate meta data by ID for a given position. It requires an API key for authorization and takes path parameters including company_id, position_id, and candidate_id. The request body must include target_position_id and target_stage_id, with an optional stage_actions_enabled boolean. The API returns a candidate object on success or various error messages for missing or invalid access tokens, not found errors, or internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Save Candidate Responses to a Questionnaire

ID: post_save_candidate_responses_to_a_questionnaire
Operation: write
Entities: position, company, candidate
Summary: This API endpoint allows saving candidate responses to a questionnaire. It requires the company_id, position_id, candidate_id, and candidate_questionnaire_id as path parameters. The request must include an Authorization header with the API key. The body of the request should contain an array of questions and their responses. On success, it returns a 204 status code. If the access token is missing or invalid, it returns a 400 or 401 status code with an error message. An unknown internal error results in a 500 status code.
Input Fields: Input Fields
Output Fields: Output Fields

Upload and Parse Resume to Create Candidate

ID: post_upload_and_parse_resume_to_create_candidate
Operation: write
Entities: position, company, candidate
Summary: This API endpoint allows users to upload and parse a resume file to create a new candidate in the Breezy HR system. The request requires an API key for authorization and includes path parameters for the company and position IDs. Optional query parameters allow specifying the pipeline stage and whether stage actions should be executed. The request body can include candidate details such as name, email, phone number, address, summary, tags, origin, source, work history, education, custom attributes, and a cover letter. The response can be a successful candidate object, a partial candidate creation notice, or various error messages depending on the outcome.
Input Fields: Input Fields
Output Fields: Output Fields

Add Custom Attribute to Candidate

ID: put_add_custom_attribute_to_candidate
Operation: write
Entities: custom attribute, company, candidate
Summary: This API adds a custom attribute to a candidate in a specified company and position. It requires an API key for authorization. The path parameters include company_id, position_id, and candidate_id, all of which are required. The body parameters include 'name' and 'value' which are required, and 'secure' which is optional and indicates if the value should be encrypted at rest. The API returns a Candidate Object on success, and various error messages for missing or invalid access tokens, or unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Add Education Entry to Candidate

ID: put_add_education_entry_to_candidate
Operation: write
Entities: company, education, candidate
Summary: This API adds an education entry to a candidate's profile. It requires the company_id, position_id, and candidate_id as path parameters, and an API key for authorization in the headers. The request body must include the school_name and can optionally include the field_of_study, start_year, and end_year. The API returns a Candidate Object on success (HTTP 200). If the access token is missing or invalid, it returns an error with HTTP 400 or 401 respectively. An unknown internal error results in an HTTP 500 response.
Input Fields: Input Fields
Output Fields: Output Fields

Add Work History Entry to Candidate

ID: put_add_work_history_entry_to_candidate
Operation: write
Entities: position, company, candidate
Summary: This API adds a work history entry to a candidate's profile in the Breezy HR system. It requires the company ID, position ID, and candidate ID as path parameters, and an API key for authorization in the headers. The request body must include the company name and can optionally include the title, summary, start month, start year, end month, and end year of the work history entry. The API returns a candidate object on success, or an error message if the access token is missing, invalid, or if there is an unknown internal error.
Input Fields: Input Fields
Output Fields: Output Fields

Move Candidate to Specified Stage

ID: put_move_candidate_to_specified_stage
Operation: write
Entities: position, company, candidate
Summary: This API endpoint is used to move a candidate to a specified stage in the hiring pipeline. The request requires an API key for authorization, and the path parameters include the company ID (referred to as secrets_companyId), position ID, and candidate ID. The body parameter 'stage_id' specifies the pipeline stage to move the candidate to, such as hired, disqualified, offer, feedback, interviewing, or applied. A successful request returns a 204 status code with no content. Errors may include missing or invalid access tokens, missing stage ID, or unknown internal errors, with corresponding error messages in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Update Candidate Custom Fields

ID: put_update_candidate_custom_fields
Operation: write
Entities: position, company, candidate
Summary: This API updates the custom fields of a candidate in a specific position within a company. It requires the company_id, position_id, candidate_id, and custom_field_id as path parameters. The Authorization header with an API key is required. The body can optionally include a 'value' parameter to specify the new value for the custom field. The API returns a 200 status code with a Candidate Custom Field Object on success. Errors include 400 for missing access token, 401 for invalid access token, and 500 for unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Update Candidate on Position

ID: put_update_candidate_on_position
Operation: write
Entities: position, company, candidate
Summary: This API updates a candidate on a specific position within a company. It requires the company_id, position_id, and candidate_id as path parameters, and an API key for authorization in the headers. The request body can include details such as the candidate's name, email address, phone number, summary, source, tags, headline, address, and cover letter. The API returns a Candidate Object on success (HTTP 200), or an error message if the access token is missing (HTTP 400), invalid (HTTP 401), or if there is an unknown internal error (HTTP 500).
Input Fields: Input Fields
Output Fields: Output Fields

Update Candidate Scorecard for User

ID: put_update_candidate_scorecard_for_user
Operation: write
Entities: user, scorecard, candidate
Summary: This API updates the scorecard for a candidate in a specific position within a company. It requires the company_id, position_id, and candidate_id as path parameters, and an API key for authorization in the headers. The request body must include a score, which can be one of the following: very_poor, poor, neutral, good, very_good. An optional note can also be included. The API returns a 204 status code on success. If the access token is missing or invalid, it returns a 400 or 401 error with a descriptive message. If an invalid score is provided, a 400 error is returned with a message indicating the allowed score values. A 500 error indicates an unknown internal error.
Input Fields: Input Fields
Output Fields: Output Fields

Update Position Custom Field

ID: put_update_position_custom_field
Operation: write
Entities: position, company, custom field
Summary: This API updates a custom field for a specific position within a company. It requires the company ID, position ID, and custom field ID as path parameters. The request must include an Authorization header with a valid API key. The body can optionally include a 'value' parameter to update the custom field. The API returns a 200 status code with the updated Position Custom Field Object on success. Error responses include 400 for missing access token or required fields, 401 for invalid access token, and 500 for unknown internal errors.
Input Fields: Input Fields
Output Fields: Output Fields

Update Position Details

ID: put_update_position_details
Operation: write
Entities: position, company
Summary: This API updates the details of a given position for a specified company. It requires the company_id and position_id as path parameters, and an Authorization header with the API key. The request body must include the state of the position, which can be 'published', 'draft', 'closed', or 'archived'. A successful request returns a 204 status code with no content. Errors may include missing access token, missing required fields, invalid access token, or an unknown internal error, each returning a 400, 401, or 500 status code with an error message.
Input Fields: Input Fields
Output Fields: Output Fields

Reject Candidate by Moving to Disqualified Stage

ID: reject_an_application
Operation: write
Entities:
Summary: This API endpoint is used to reject a candidate by moving them to the 'disqualified' stage in the hiring pipeline. The request requires an API key for authorization, and the path parameters include the company ID, position ID, and candidate ID. The 'stage_id' in the body is set to 'disqualified' to move the candidate to the disqualified stage. A successful request returns a 204 status code with no content. Errors may include missing or invalid access tokens, missing stage ID, or unknown internal errors, with corresponding error messages in the response body.
Input Fields: Input Fields
Output Fields: Output Fields