Traffit API Integration

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

Remove Owner/Responsible Person from the Recruitment

ID: delete_owner_from_recruitment
Operation: write
Entities: owner, user, recruitment
Summary: This API endpoint is used to remove an owner or responsible person from a recruitment process. It requires the recruitment ID and user ID as path parameters. The request must include headers for 'Content-Type' set to 'application/json' and 'Authorization' with a valid Bearer token. If the authorization key is invalid, the response will include an error message.
Input Fields: Input Fields
Output Fields: Output Fields

Remove webhook

ID: delete_remove_webhook
Operation: write
Entities: webhook
Summary: The 'Remove webhook' API allows you to delete a webhook by its ID. It requires a DELETE request to the specified endpoint with the webhook ID as a path parameter. The request must include an Authorization header with a valid bearer token. Optionally, the X-Response-Metadata header can be included to receive response metadata. The API returns a 204 response code on success. If the authorization key is invalid, an error message is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Get all job posts

ID: get_all_job_posts
Operation: read
Entities: publication, job post
Summary: This API endpoint retrieves all job posts associated with a specific recruitment ID. It requires an authorization token with the 'recruitment' scope. The request headers include 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. The 'recruitment_id' is a required path parameter. The response is a list of job posts, each containing details such as 'id', 'name', 'language', 'multiposting', and 'publications'. Each publication includes 'id', 'nr_ref', 'url', 'valid_start', and 'valid_end'.
Input Fields: Input Fields
Output Fields: Output Fields

Get all job rejections

ID: get_all_job_rejections
Operation: read
Entities: rejection, recruitment
Summary: This API retrieves all job rejection states for a specific recruitment. It requires a recruitment_id as a path parameter and an authorization token with the 'recruitment' scope. The request headers include 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. The response is an array of rejection states, each with a 'state_type', 'id', and 'name'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Application Form

ID: get_application_form
Operation: read
Entities: application form, provision, field
Summary: The Get Application Form API retrieves the application form fields for a specific advert identified by the advert_id. It requires an authorization token with the 'form' scope. The request must include the 'Content-Type' and 'Authorization' headers. The 'advert_id' is a required path parameter. The response includes the required fields and provisions for the application form, with details such as field ID, name, SID, type, and order, as well as provision ID, name, and content.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate activities

ID: get_candidate_activities
Operation: read
Entities: activity, employee, type
Summary: The 'Get candidate activities' API retrieves a list of activities associated with a specific employee. The API requires an authorization token with the 'employee' scope. The endpoint accepts various headers including 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. It also supports filtering through query parameters such as 'created_at', 'updated_at', 'id', 'sort_by', 'type', 'activity_date', and 'created_by_id', each with their respective comparison operators. The response is a list of activity objects, each containing details like 'id', 'activity_date', 'type', 'content', 'created_by', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate files

ID: get_candidate_files
Operation: read
Entities: employee, file
Summary: The 'Get candidate files' API retrieves a single candidate file associated with a specific employee. It requires an authorization token with the 'employee' scope. The request must include the 'Content-Type' and 'Authorization' headers. The 'employee_id' is a required path parameter, while 'file_id' is optional. The response returns a JSON array containing details of the file, including its ID, name, and type.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate jobs

ID: get_candidate_jobs
Operation: read
Entities: employee, job, candidate
Summary: The 'Get candidate jobs' API retrieves a list of jobs associated with a specific employee ID. It requires an authorization token with the 'employee' scope. The request must include the 'Content-Type' and 'Authorization' headers, and optionally 'X-Request-Page-Size' and 'X-Request-Current-Page' headers for pagination. The 'employee_id' is a required path parameter. The response is an array of recruitment objects, each containing an 'id' and 'name'.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate provisions

ID: get_candidate_provisions
Operation: read
Entities: employee, provision, candidate
Summary: The 'Get candidate provisions' API allows you to retrieve provisions associated with a specific employee by their ID. The API requires an authorization token with the 'employee' scope. The request headers include 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. The 'employee_id' is a required path parameter. Optional query parameters include 'advert_id', 'recruitment_id', and 'provision_id' for filtering results. The response is a list of provisions, each containing details such as communication channels, provision ID, advert ID, recruitment ID, withdraw date, content, and creation date.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate sources

ID: get_candidate_sources
Operation: read
Entities: employee, source, employee application
Summary: The 'Get candidate sources' API retrieves the sources of candidates associated with a specific employee. It requires an authorization token with the 'source' scope. The request must include the employee ID as a path parameter. Optional headers can specify pagination details, such as the number of items per page and the current page number. The response is an array of source objects, each containing details like the source ID, domain, URL, dictionary item ID, and recruitment ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate tags

ID: get_candidate_tags
Operation: read
Entities: employee, tag
Summary: This API retrieves the tags associated with a specific employee by their ID. It requires an authorization token with the 'employee' scope. The request headers include 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. The 'employee_id' is a required path parameter. The response is a list of tags, each with an 'id' and 'name'.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidate talents

ID: get_candidate_talents
Operation: read
Entities: talent, employee, candidate
Summary: The 'Get candidate talents' API retrieves the talents associated with a specific employee ID. It requires an authorization token with the 'employee' scope. The request headers include 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. The 'employee_id' is a required path parameter. The response is an array of talent objects, each containing 'id', 'name', and 'public' status.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidates activities

ID: get_candidates_activities
Operation: read
Entities: activity, employee, candidate
Summary: The 'Get candidates activities' API allows users to retrieve a list of activities related to candidates. It requires an authorization token with the 'employee' scope. The API supports various headers such as 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. It also supports filtering through query parameters like 'created_at', 'updated_at', 'id', 'sort_by', 'type', 'activity_date', 'employee_id', and 'created_by_id', each with their respective comparison fields. The response is a list of activities, each containing details such as the activity ID, employee details, activity date, type, recruitment ID, content, creator ID, and timestamps for creation and updates.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidates from job

ID: get_candidates_from_job
Operation: read
Entities: job, recruitment, candidate
Summary: This API retrieves candidates associated with a specific job identified by the recruitment_id. It requires an authorization token with the 'recruitment' scope. The API supports various headers for pagination, filtering, and sorting. The recruitment_id is a required path parameter. The response includes a list of candidates with details such as id, name, lastname, status, email, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidates from job state

ID: get_candidates_from_job_state
Operation: read
Entities: job, state, candidate
Summary: This API retrieves candidates from a specific job state. It requires a recruitment ID and a state ID as path parameters. The request headers must include a Content-Type of application/json and an Authorization bearer token. Optional headers include X-Request-Page-Size and X-Request-Current-Page for pagination. The response is a list of candidates, each with details such as ID, name, lastname, status, email, and optionally, the source of the candidate.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidates jobs history

ID: get_candidates_jobs_history
Operation: read
Entities: employee, workflow state, recruitment
Summary: The 'Get candidates jobs history' API retrieves the job history of candidates. It requires an authorization token with the 'employee' scope. The API supports various headers such as 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. It also allows filtering through query parameters like 'created_at', 'updated_at', 'id', 'sort_by', 'employee_id', 'recruitment_id', 'workflow_state_type', and 'workflow_state_id'. The response is a list of job history records, each containing details like 'id', 'employee', 'recruitment', 'workflow_state', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Get candidates list

ID: get_candidates_list
Operation: read
Entities: employee, candidate
Summary: The 'Get candidates list' API retrieves all candidates from the system. It requires an authorization token with the 'employee' scope. The API supports various headers for pagination, filtering, and sorting. The 'Authorization' header is mandatory, while others like 'X-Request-Page-Size', 'X-Request-Current-Page', 'X-Request-Filter', and 'X-Request-Sort' are optional. The response is a list of candidates, each with details such as id, name, lastname, status, email, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get Candidates Provisions

ID: get_candidates_provisions
Operation: read
Entities: employee, provision, candidate
Summary: The 'Get Candidates Provisions' API retrieves a list of provisions associated with candidates. It requires an authorization token with employee scope. The API supports pagination through headers 'X-Request-Page-Size' and 'X-Request-Current-Page'. It also allows sorting by 'id', 'created_at', or 'updated_at' in either 'ASC' or 'DESC' order using query parameters 'sort_by' and 'sort_by_direction'. The response includes details such as communication channels, provision ID, employee ID, advert ID, recruitment ID, withdraw date, content, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get clients list

ID: get_clients_list
Operation: read
Entities: client
Summary: The 'Get clients list' API retrieves all clients associated with your account. It requires an authorization token with the 'client' scope. The API supports various headers for pagination, filtering, and sorting. The 'Authorization' header is mandatory, while others like 'X-Request-Page-Size', 'X-Request-Current-Page', 'X-Request-Filter', and 'X-Request-Sort' are optional. The response is a list of clients, each with details such as 'id', 'created_by', 'updated_by', 'created_at', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Get CRM Activities List

ID: get_crm_activities_list
Operation: read
Entities: client, user, crm activity
Summary: The Get CRM Activities List API retrieves all CRM activities associated with your account. It requires an authorization token with the 'crm_activity' scope. The API supports various headers for pagination, filtering, and sorting. The response includes a list of CRM activities, each with details such as id, client id, creation and update timestamps, and the ids of the creator and updater.
Input Fields: Input Fields
Output Fields: Output Fields

Get CRM Persons List

ID: get_crm_persons_list
Operation: read
Entities: crm person, client
Summary: The Get CRM Persons List API retrieves all CRM persons from the system. It requires an authorization token with the 'crm_persons' scope. The API supports various headers for pagination, filtering, and sorting. The response includes details such as the ID, name, lastname, email, and timestamps for creation and updates of each CRM person, along with the associated client information.
Input Fields: Input Fields
Output Fields: Output Fields

Get job pending rejections

ID: get_job_pending_rejections
Operation: read
Entities: rejection, job, recruitment
Summary: The 'Get job pending rejections' API retrieves the pending rejection states for a specific job recruitment. It requires a valid authorization token with the 'recruitment' scope. The API endpoint includes a path parameter 'recruitment_id' which is the ID of the job. The request headers must include 'Content-Type' as 'application/json' and 'Authorization' as a Bearer token. Optional headers 'X-Request-Page-Size' and 'X-Request-Current-Page' can be used for pagination. The response is an array of objects, each representing a pending rejection state with 'state_type', 'id', and 'name'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Job Posts Published

ID: get_job_posts_published
Operation: read
Entities: recruitment, job post, advertisement
Summary: The 'Get Job Posts Published' API retrieves a list of published job posts from the Traffit system. It supports various headers for pagination, filtering, and sorting. The headers include 'X-Request-Page-Size' for specifying the number of job posts per page, 'X-Request-Current-Page' for the current page number, 'X-Request-Filter' for filtering job posts based on criteria such as job_post_id, and 'X-Request-Sort' for sorting the job posts. The response is a list of job posts, each containing details such as the job post ID, advert information, URL, validity period, and options like job type and location. The API returns a 200 response code with the job posts in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Job Rejections

ID: get_job_rejections
Operation: read
Entities: rejection, job, recruitment
Summary: The 'Get Job Rejections' API retrieves the rejection states for a specific job recruitment. It requires a valid authorization token with the 'recruitment' scope. The API endpoint requires a 'recruitment_id' as a path parameter to specify the job ID. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' bearer token. Optional headers include 'X-Request-Page-Size' and 'X-Request-Current-Page' for pagination. The response is an array of objects, each containing 'state_type', 'id', and 'name' of the rejection state.
Input Fields: Input Fields
Output Fields: Output Fields

Get job states

ID: get_job_states
Operation: read
Entities: workflow, state, recruitment
Summary: The 'Get job states' API retrieves the states of a specific job recruitment process. It requires a valid authorization token with the 'recruitment' scope. The API endpoint requires a 'recruitment_id' as a path parameter to specify the job ID. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' bearer token. Optional headers include 'X-Request-Page-Size' and 'X-Request-Current-Page' for pagination. The response is a list of states, each with details such as 'id', 'name', 'sid', 'type', 'workflow', 'time_limit', and 'order'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Job States Counter

ID: get_job_states_counter
Operation: read
Entities: job, state, recruitment
Summary: The 'Get Job States Counter' API retrieves the count of different states for a specific job identified by the recruitment_id. It requires an authorization token with the 'recruitment' scope. The request headers include 'Content-Type', 'Authorization', 'X-Request-Page-Size', and 'X-Request-Current-Page'. The recruitment_id is a required path parameter. The response is an array of objects, each containing 'stateCount' and 'state', representing the count and identifier of each state.
Input Fields: Input Fields
Output Fields: Output Fields

Get jobs list

ID: get_jobs_list
Operation: read
Entities: client, user, job
Summary: The 'Get jobs list' API retrieves all jobs from the specified endpoint. It requires an authorization token with the 'recruitment' scope. The API supports various headers for pagination, filtering, and sorting. The response includes job details such as ID, status, name, client information, creation and update timestamps, and closure status. The API returns a list of jobs in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

Get Provision Types

ID: get_provision_types
Operation: read
Entities: provision type
Summary: The Get Provision Types API retrieves all provision types available in the system. It requires an authorization token with the 'provision' scope. The request headers include 'Authorization' for the bearer token, 'X-Request-Page-Size' for specifying the number of items per page, and 'X-Request-Current-Page' for the current page number. The response is an array of provision types, each with an 'id', 'sys_name', and 'value'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Provisions List

ID: get_provisions_list
Operation: read
Entities: provision
Summary: The Get Provisions List API retrieves all provisions from the Traffit system. It requires an authorization token with the 'provision' scope. The API supports pagination through headers 'X-Request-Page-Size' and 'X-Request-Current-Page'. It also allows filtering by 'language', 'is_active', and 'type' through query parameters. The response includes a list of provisions with details such as ID, name, start and closing dates, content, active status, language, type, and last update timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Candidate

ID: get_single_candidate
Operation: read
Entities: file, source, candidate
Summary: The 'Get Single Candidate' API retrieves detailed information about a specific candidate using their employee ID. The request requires an authorization token with the 'employee' scope. The endpoint supports optional headers for finding by GUID and response metadata. The response includes the candidate's ID, name, status, associated files, email, source, owner, creation and update timestamps, and the IDs of the creator and last updater.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Client

ID: get_single_client
Operation: read
Entities: client
Summary: The 'Get Single Client' API retrieves a single client by their ID or GUID. It requires an authorization token with the 'client' scope. The request must include the 'Authorization' and 'Content-Type' headers. The 'client_id' is a required path parameter. The response includes the client's ID, creator and updater IDs, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single CRM Activity

ID: get_single_crm_activity
Operation: read
Entities: client, user, crm activity
Summary: This API retrieves a single CRM activity by its ID. It requires an authorization token with the 'crm_activity' scope. The request must include the 'Content-Type' and 'Authorization' headers. The 'crm_activity_id' is a required path parameter. The response includes details of the CRM activity such as its ID, client ID, creation and update timestamps, and the IDs of the users who created and last updated the activity.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single CRM Person

ID: get_single_crm_person
Operation: read
Entities: crm person, client, authorization token
Summary: This API retrieves a single CRM person by their ID or GUID. It requires an authorization token with the 'crm_person' scope. The request must include the 'Content-Type' and 'Authorization' headers. The 'crm_person_id' is a required path parameter. The response includes details about the CRM person such as their ID, name, email, and information about who created and last updated the record, along with timestamps and client information.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Job

ID: get_single_job
Operation: read
Entities: responsible person, client, job
Summary: The 'Get Single Job' API retrieves a single job by its ID or GUID. It requires an authorization token with the 'recruitment' scope. The API supports optional headers such as 'X-Get-Find-By-Guid' and 'X-Response-Metadata'. The required URI parameter is 'recruitment_id', which is the ID of the job. The request headers must include 'Authorization' and 'Content-Type'. The response includes details about the job such as 'workflow_id', 'id', 'status', 'name', 'client', 'responsible_person', 'created_by', 'updated_by', 'created_at', 'updated_at', and 'is_closed'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Job Post

ID: get_single_job_post
Operation: read
Entities: job post, authorization token, response header
Summary: This API retrieves a single job post by its ID. It requires an authorization token with the 'advert_publish' scope. The request must include the 'Content-Type' and 'Authorization' headers. The 'advert_publish_id' is a required path parameter that specifies the job post ID. The response includes details such as the advert ID, job post ID, reference number, URL, validity period, and whether the job post has been awarded.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Job Posts

ID: get_single_job_posts
Operation: read
Entities: publication, job post, recruitment
Summary: The 'Get Single Job Posts' API retrieves details of a specific job post using the recruitment ID and job post ID. It requires an authorization token with the 'recruitment' scope. The request headers must include 'Content-Type' as 'application/json' and 'Authorization' as a Bearer token. Optional headers include 'X-Request-Page-Size' and 'X-Request-Current-Page' for pagination. The response includes the job post's ID, name, language, URL, multiposting details, and a list of publications with their respective IDs, reference numbers, URLs, and validity periods.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single Source

ID: get_single_source
Operation: read
Entities: employee, source, authorization token
Summary: The 'Get Single Source' API retrieves a single source by its ID. It requires a GET request to the specified endpoint with the source ID as a path parameter. The request must include headers for 'Content-Type' set to 'application/json' and 'Authorization' with a Bearer token. The response includes details of the source such as its ID, domain, URL, dictionary item ID, external ID, and employee ID.
Input Fields: Input Fields
Output Fields: Output Fields

Get Single User

ID: get_single_user
Operation: read
Entities: permission group, user group, user
Summary: The 'Get Single User' API retrieves a single user's details by their ID. It requires a GET request to the specified endpoint with the user ID as a path parameter. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a Bearer token. The response includes user details such as username, email, user group, permission group, and status of activity.
Input Fields: Input Fields
Output Fields: Output Fields

Get sources list

ID: get_sources_list
Operation: read
Entities: employee, dictionary item, source
Summary: The 'Get sources list' API retrieves all sources associated with your account. It requires an authorization token with the 'source' scope. The API supports pagination through the 'X-Request-Page-Size' and 'X-Request-Current-Page' headers. Additionally, it allows filtering using the 'X-Request-Filter' header. The response includes an array of source objects, each containing details such as 'id', 'domain', 'url', 'dictionaryItem', 'externalId', and 'employee'.
Input Fields: Input Fields
Output Fields: Output Fields

Get talents list

ID: get_talents_list
Operation: read
Entities: talent, employee, authorization
Summary: The 'Get talents list' API retrieves all talents from the Traffit system. It requires an authorization token with the 'talent' scope. The API supports various headers for pagination and sorting, such as 'X-Request-Page-Size' and 'X-Request-Current-Page'. It also allows filtering talents by 'id' and 'name' through query parameters. The response includes a list of talents, each with an 'id' and 'name', and may include additional information such as the 'talent_employees_counter'.
Input Fields: Input Fields
Output Fields: Output Fields

Get user groups list

ID: get_user_groups_list
Operation: read
Entities: user group, authorization token
Summary: The 'Get user groups list' API retrieves all user groups associated with your account. It requires an authorization token with the 'user' scope. The API supports various headers for pagination, sorting, and filtering. The 'Authorization' header is mandatory, while 'X-Request-Page-Size', 'X-Request-Current-Page', 'X-Request-Sort', and 'X-Request-Filter' are optional. The response is a list of user groups, each containing an 'id', 'name', 'status', and 'external_id'.
Input Fields: Input Fields
Output Fields: Output Fields

Get User Permission Groups List

ID: get_user_permission_groups_list
Operation: read
Entities: permission group, user
Summary: The 'Get User Permission Groups List' API retrieves all user permission groups available in the system. It requires an authorization token with the 'user' scope. The API supports pagination and sorting through headers. The request headers include 'Authorization' for the bearer token, 'X-Request-Page-Size' for the number of items per page, 'X-Request-Current-Page' for the current page number, and 'X-Request-Sort' for sorting criteria. The response is a list of permission groups, each with an 'id', 'name', and 'description'.
Input Fields: Input Fields
Output Fields: Output Fields

Get Users List

ID: get_users_list
Operation: read
Entities: permission group, user group, user
Summary: The Get Users List API retrieves all users from the system. It requires an authorization token with the 'user' scope. The API supports various headers for pagination, filtering, and sorting. The response includes user details such as username, email, user group, permission group, and active status. The API returns a list of users with their respective details.
Input Fields: Input Fields
Output Fields: Output Fields

Get Webhook Types

ID: get_webhook_types
Operation: read
Entities: webhook, job, candidate
Summary: The 'Get Webhook Types' API retrieves a list of available webhook event types from the Traffit system. It requires an authorization token with the 'webhook' scope. The request headers must include 'Authorization' with a Bearer token, and optionally 'X-Response-Metadata' to include response metadata. The API responds with a 200 status code and returns an array of strings, each representing a different webhook event type such as 'advert_published', 'candidate_created', 'job_updated', etc.
Input Fields: Input Fields
Output Fields: Output Fields

Get workflow states stats

ID: get_workflow_states_stats
Operation: read
Entities: workflow, state, candidate
Summary: The 'Get workflow states stats' API retrieves statistics about the states within a specified workflow. It requires a 'workflow_id' as a path parameter to identify the workflow. The request must include headers for 'Content-Type' set to 'application/json' and 'Authorization' with a Bearer token. The response is an array of objects, each representing a state with its ID, name, SID, and the count of candidates in that state.
Input Fields: Input Fields
Output Fields: Output Fields

Get workflow with states details

ID: get_workflow_with_states_details
Operation: read
Entities: workflow, state
Summary: This API retrieves the details of a specific workflow along with its states from the Traffit system. The request requires a valid workflow ID as a path parameter and authorization via a Bearer token in the headers. The response includes the workflow ID, name, and a list of states, each with its own ID, name, type, optional SID, time limit, and order.
Input Fields: Input Fields
Output Fields: Output Fields

Get workflows

ID: get_workflows
Operation: read
Entities: workflow
Summary: The 'Get workflows' API retrieves a list of workflows from the Traffit system. It requires a GET request to the specified endpoint with a mandatory 'workflow_id' query parameter. The request must include headers for 'Content-Type' as 'application/json' and an 'Authorization' bearer token. The response is a JSON array containing details of each workflow, including its ID, name, active status, and last updated timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Add many provisions to the candidate

ID: patch_add_many_provisions_to_the_candidate
Operation: write
Entities: employee, provision, recruitment
Summary: This API allows adding multiple provisions to a candidate identified by the employee ID. The request requires an authorization token with the 'employee' scope. The endpoint accepts a PATCH request with a JSON array in the body, where each object contains 'recruitment', 'provision', and 'agreement_date'. The 'employee_id' is a required path parameter. The response returns a 204 status code with a JSON array reflecting the provisions added, where 'recruitment' can be null.
Input Fields: Input Fields
Output Fields: Output Fields

Add tags to the candidate

ID: patch_add_tags_to_candidate
Operation: write
Entities: employee, tag, candidate
Summary: This API allows you to add tags to a candidate by specifying the employee ID in the path parameters. The request requires an authorization token with the 'employee' scope. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' header with a Bearer token. The body of the request should contain an array of tags to be added. The response returns a 204 status code with a list of tags added to the candidate.
Input Fields: Input Fields
Output Fields: Output Fields

Update Job

ID: patch_update_job
Operation: write
Entities: client, recruitment, job
Summary: The Update Job API allows you to update all data related to a specific job using the PATCH method. The endpoint requires a recruitment_id as a path parameter to identify the job to be updated. The request must include headers for authorization and content type, and optionally X-Request-Metadata. The body of the request should contain the name, guid, synchro_time, client, and workflow of the recruitment. The response returns a 204 status code with the updated job details in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Fields on the Candidate

ID: patch_update_single_fields_on_the_candidate
Operation: write
Entities: field, authorization token, candidate
Summary: This API allows updating selected fields on a candidate using the PATCH method. The request requires an authorization token with the 'employee' scope. The endpoint requires the 'employee_id' as a path parameter. The request headers must include 'Content-Type' as 'application/json' and 'Authorization' as a Bearer token. Optional metadata can be included in the 'X-Request-Metadata' header. The request body can include fields such as 'email', 'synchro_time', and '_additional_custom_field' to update the candidate's information. A successful request returns a 204 response code with the updated fields in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Fields on the Client

ID: patch_update_single_fields_on_the_client
Operation: write
Entities: client
Summary: This API allows updating selected fields on a client. It requires a PATCH request to the specified endpoint with the client_id as a path parameter. The request must include headers for Content-Type and Authorization. The Authorization header requires a bearer token with the 'client' scope. Optionally, an X-Request-Metadata header can be included. The request body can contain the fields to be updated. A successful request returns a 204 status code with a response body containing the synchronization time and any additional custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update single fields on the crm_person

ID: patch_update_single_fields_on_the_crm_person
Operation: write
Entities: crm person
Summary: This API allows updating selected fields on a crm_person. It requires a PATCH request to the specified endpoint with the crm_person_id as a path parameter. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/json. Optional fields such as lastname and email can be included in the request body to update the respective fields of the crm_person. A successful update returns a 204 response code with an empty body.
Input Fields: Input Fields
Output Fields: Output Fields

Update Single Fields on the Job

ID: patch_update_single_fields_on_the_job
Operation: write
Entities: job, field, recruitment
Summary: This API allows updating selected fields on a job using the PATCH method. The endpoint requires a recruitment_id as a path parameter to identify the job. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/json. Optionally, an X-Request-Metadata header can be included. The request body should contain the fields to be updated, such as 'name', 'synchro_time', and any additional custom fields. The API responds with a 204 status code and the updated job details in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Update user

ID: patch_update_user
Operation: write
Entities: user
Summary: The Update User API allows you to update selected fields on a user. It requires a PATCH request to the specified endpoint with the user ID as a path parameter. The request must include headers for Content-Type and Authorization with a bearer token. Optionally, X-Request-Metadata can be included. The request body can contain fields like 'username' to update the user's information. A successful request returns a 204 response code with the updated user information in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Add candidate to the recruitment

ID: post_add_candidate_to_the_recruitment
Operation: write
Entities: employee, recruitment, candidate
Summary: This API endpoint allows you to add a candidate to a specific recruitment process. It requires the recruitment ID and employee ID as path parameters. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' bearer token. The request body can optionally include 'source_dictionary_item_id', 'utm_source', 'utm_medium', and 'utm_campaign'. The response returns a 204 status code.
Input Fields: Input Fields
Output Fields: Output Fields

Add file and assign it to the candidate

ID: post_add_file_and_assign_it_to_the_candidate
Operation: write
Entities: employee, file, candidate
Summary: This API endpoint allows you to add a file and assign it to a candidate by specifying the employee ID in the path parameters. The request must include a multipart/form-data body with the file details, including the file path, whether the file should be public, and the file dictionary type. The request headers must include the Content-Type as 'multipart/form-data' and an Authorization bearer token. Upon successful creation, the API returns a 201 status code with the ID of the newly created file in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Add many candidates to talent

ID: post_add_many_candidates_to_talent
Operation: write
Entities: talent, candidate
Summary: The 'Add many candidates to talent' API allows users to add multiple candidates to a specified talent pool. The API requires a POST request to the specified endpoint with the talent_id as a path parameter. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' bearer token. The request body should contain an array of employee IDs under the 'employees' key. Upon successful execution, the API returns a 204 response code with a body containing the list of employee IDs that were added.
Input Fields: Input Fields
Output Fields: Output Fields

Add note to the candidate

ID: post_add_note_to_the_candidate
Operation: write
Entities: employee, note
Summary: This API allows you to add a note to a candidate by specifying the employee ID in the path parameters. The request requires headers for Content-Type and Authorization. The body of the request should include the title and content of the note. The response returns a 204 status code with the note's title and content.
Input Fields: Input Fields
Output Fields: Output Fields

Add owner/responsible person to the recruitment

ID: post_add_owner_responsible_person_to_the_recruitment
Operation: write
Entities: owner, user, recruitment
Summary: This API endpoint is used to add an owner or responsible person to a recruitment process. It requires the recruitment ID and user ID as path parameters. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a Bearer token. A successful request returns a 204 response code, indicating no content. If the authorization key is invalid, an error message is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Add provision to the candidate

ID: post_add_provision_to_candidate
Operation: write
Entities: employee, provision
Summary: This API endpoint allows you to add a provision to a candidate by specifying the employee ID and provision ID in the path parameters. The request requires authorization via a Bearer token and must include a JSON body with the recruitment ID and agreement date. The response returns a 204 status code with the recruitment ID and agreement date in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Add user to a group

ID: post_add_user_to_a_group
Operation: write
Entities: group, user
Summary: This API endpoint allows you to add a user to a specific group. It requires a POST request to the specified URL with the user_id and group_id as path parameters. The request must include an Authorization header with a bearer token. If the user is already in the group, the response will include an error message. The response code for a successful operation is 204.
Input Fields: Input Fields
Output Fields: Output Fields

Advert Apply

ID: post_advert_apply
Operation: write
Entities: advert, authorization token, application
Summary: The Advert Apply API allows users to apply for a specific advert by providing necessary details. It requires a POST request to the specified endpoint with the advert ID as a path parameter. The request must include headers for content type, authorization, and request metadata. Optional query parameters can be used to specify the source, campaign, and medium of the traffic. The response provides details of the fields required for the application, including their types, whether they are required, and any choices available.
Input Fields: Input Fields
Output Fields: Output Fields

Create new candidate

ID: post_create_new_candidate
Operation: write
Entities: employee, source, candidate
Summary: This API endpoint allows the creation of a new candidate in the system. It requires a POST request to the specified URL with a JSON body containing the candidate's details such as name, lastname, email, source, and synchronization time. The Authorization header with a bearer token is required for authentication. The response returns the created candidate's details including an additional custom field.
Input Fields: Input Fields
Output Fields: Output Fields

Create new client

ID: post_create_new_client
Operation: write
Entities: client
Summary: The 'Create new client' API allows you to create a new client in the system. It requires a POST request to the specified endpoint with a JSON body containing 'guid' and 'synchro_time'. The request must include an Authorization header with a Bearer token. The response returns a 201 status code with the same 'guid' and 'synchro_time' in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Create new crm_person

ID: post_create_new_crm_person
Operation: write
Entities: crm person, client
Summary: This API endpoint allows the creation of a new CRM person in the system. It requires a POST request to the specified URL with a JSON body containing the person's details such as name, lastname, email, guid, synchro_time, and client ID. The request must include an Authorization header with a Bearer token. The response returns the details of the created CRM person.
Input Fields: Input Fields
Output Fields: Output Fields

Create new job

ID: post_create_new_job
Operation: write
Entities: header, job, authorization token
Summary: This API endpoint allows the creation of a new job recruitment. It requires a POST request to the specified URL with a JSON body containing the recruitment details such as name, guid, synchro_time, client, and workflow. The request must include an Authorization header with a bearer token. The response returns the details of the created recruitment.
Input Fields: Input Fields
Output Fields: Output Fields

Create new user

ID: post_create_new_user
Operation: write
Entities: permission group, password, user
Summary: This API endpoint allows for the creation of a new user in the system. It requires a POST request to the specified URL with a JSON body containing the user's username, permission group, email, password, and group ID. The request must include an Authorization header with a Bearer token. The response returns the details of the created user, including the username, permission group, email, password, and group ID.
Input Fields: Input Fields
Output Fields: Output Fields

Create talent

ID: post_create_talent
Operation: write
Entities: talent, authorization token
Summary: The 'Create talent' API allows users to create a new talent entry in the system. It requires a POST request to the specified endpoint with a JSON body containing the talent's name, visibility status (public), description, and associated colour. The request must include headers for 'Content-Type' set to 'application/json' and 'Authorization' with a valid bearer token. Upon successful creation, the API returns a 201 status code along with the details of the created talent in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Disable user

ID: post_disable_user
Operation: write
Entities: user
Summary: The Disable User API allows you to disable a user account in the Traffit system. It requires a POST request to the specified endpoint with the user ID as a path parameter. The request must include an Authorization header with a bearer token that has the required scope. If the user is already disabled, the API will return an error message in the response body. The response code for a successful operation is 204, indicating no content.
Input Fields: Input Fields
Output Fields: Output Fields

Enable User

ID: post_enable_user
Operation: write
Entities: user
Summary: The Enable User API allows you to enable a user in the system. It requires a POST request to the specified endpoint with the user ID as a path parameter. The request must include an Authorization header with a bearer token and a Content-Type header set to application/json. If the user is already enabled, the response will include an error message indicating this. The response code for a successful operation is 204.
Input Fields: Input Fields
Output Fields: Output Fields

Generating access token

ID: post_generating_access_token
Operation: write
Entities: access token, client, scope
Summary: This API generates an OAuth token that is valid for 30 days. It requires the client_id, client_secret, grant_type, and scope as parameters. The grant_type should always be 'client_credentials'. The scope can include one or many scopes separated by space. The request must include a Content-Type header set to 'application/json'. The response includes the client_id, client_secret, grant_type, and scope used in the request.
Input Fields: Input Fields
Output Fields: Output Fields

Move candidate in job to next state

ID: post_move_candidate_in_job_to_next_state
Operation: write
Entities: employee, state, recruitment
Summary: This API moves a candidate in a job to the next state. It requires the employee ID and recruitment ID as path parameters. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' header with a Bearer token. The API returns a 204 response code with a message indicating the result of the operation, such as 'Notransitionforaction'.
Input Fields: Input Fields
Output Fields: Output Fields

Move candidate in job to state

ID: post_move_candidate_in_job_to_state
Operation: write
Entities: employee, state, recruitment
Summary: This API endpoint is used to move a candidate in a job to a specified state. It requires the employee ID, recruitment ID, and state ID as path parameters. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a Bearer token. The API responds with a 204 status code and a message indicating the result of the operation, such as 'Notransitionforaction'.
Input Fields: Input Fields
Output Fields: Output Fields

Register webhook

ID: post_register_webhook
Operation: write
Entities: header, webhook, authorization token
Summary: The Register webhook API allows you to register a new webhook for specific events in the Traffit system. It requires a POST request to the specified endpoint with a JSON body containing the 'type' of event and the 'url' where the webhook data should be sent. The request must include an Authorization header with a Bearer token. Upon successful registration, the API returns a 201 status code with the details of the registered webhook in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Reject Candidate in Job

ID: post_reject_candidate_in_job
Operation: write
Entities: employee, job, candidate
Summary: The 'Reject Candidate in Job' API allows you to move a candidate to a reject state for a specific job recruitment. It requires the employee ID and recruitment ID as path parameters. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' bearer token. The request body must contain a 'rejection_id' indicating the reason for rejection. Upon successful execution, the API returns a 204 response code with the rejection ID in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Remove many candidates from talent

ID: post_remove_many_candidates_from_talent
Operation: write
Entities: talent, employee, candidate
Summary: The 'Remove many candidates from talent' API allows users to remove multiple candidates from a specified talent pool. The API requires a POST request to the specified endpoint with a path parameter 'talent_id' indicating the talent pool ID. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' bearer token. The request body should contain an array of 'employees' IDs to be removed. Upon successful execution, the API returns a 204 response code with a list of removed employee IDs in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Upload file

ID: post_upload_file
Operation: write
Entities: file
Summary: The 'Upload file' API allows users to upload a file to the Traffit system. It requires a POST request to the specified endpoint with a multipart/form-data content type. The request must include an Authorization header with a Bearer token. The body of the request should contain the file to be uploaded, specified with its filename and type, and optionally a new filename and a flag indicating if the file should be public. Upon successful upload, the API returns a 201 status code with a JSON response containing the ID of the uploaded file.
Input Fields: Input Fields
Output Fields: Output Fields

Update Candidate

ID: put_update_candidate
Operation: write
Entities: employee, source, candidate
Summary: The Update Candidate API allows you to update all data related to a candidate using their employee ID. It requires a PUT request to the specified endpoint with the employee ID as a path parameter. The request must include headers for Content-Type and Authorization, and optionally X-Request-Metadata. The request body should contain the candidate's name, lastname, email, source, and synchro_time. The response returns a 204 status code with the updated candidate details including name, lastname, email, guid, owner, source, synchro_time, and any additional custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update client

ID: put_update_client
Operation: write
Entities: client
Summary: The 'Update client' API allows you to update all data for a specific client identified by the client_id. It requires a PUT request to the specified endpoint with the client_id as a path parameter. The request must include headers for authorization and content type, and optionally X-Request-Metadata. The body of the request should contain a unique guid and a synchro_time in the format YYYY-MM-DD HH:MM:SS. The response returns a 204 status code with the updated guid and synchro_time in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Update CRM Person

ID: put_update_crm_person
Operation: write
Entities: crm person, authorization token
Summary: The Update CRM Person API allows you to update all data related to a CRM person identified by the crm_person_id. It requires a PUT request to the specified endpoint with the crm_person_id as a path parameter. The request must include headers for Content-Type and Authorization with a Bearer token. The body of the request can include optional fields such as name, lastname, email, guid, synchro_time, and client. The response returns a 204 status code with the updated CRM person details in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Update source

ID: put_update_source
Operation: write
Entities: header, source, authorization token
Summary: The 'Update source' API allows you to update all data related to a specific source identified by the 'source_id'. This API requires a PUT request to the specified endpoint with the 'source_id' as a path parameter. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a Bearer token. The request body should contain the 'domain' and 'url' of the source. Upon successful update, the API returns a 204 response code with a response body containing the updated 'domain', 'url', 'external_id', and 'dictionary_item_id'.
Input Fields: Input Fields
Output Fields: Output Fields