smartrecruiters_python_client

The SmartRecruiters API provides a platform to integrate services or applications, build apps and create fully customizable career sites. It exposes SmartRecruiters functionality and allows to connect and build software enhancing it.

This Python package is automatically generated by the Swagger Codegen project:

API version: 1
Package version: 0.0.1
Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/roksela/smartrecruiters-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/roksela/smartrecruiters-python-client.git)

Then import the package:

import smartrecruiters_python_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import smartrecruiters_python_client

Getting Started

Please follow the installation procedure and then run the following:

import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# create an instance of the API class
jobs_api = smartrecruiters_python_client.JobsApi()

try:
    # Get the list of jobs.
    jobs = jobs_api.jobs_all()
    print(jobs.total_found)
except ApiException as e:
    print("Exception when calling JobsApi->jobs_all: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.smartrecruiters.com/

Class	Method	HTTP request	Description
AnalyticsApi	analytics_applications	GET /analytics/applications	Get the list of applications.
AnalyticsApi	analytics_hiring_team	GET /analytics/hiring-team	Get the list of hiring team members.
AnalyticsApi	analytics_interviews	GET /analytics/interviews	Get the list of interviews.
AnalyticsApi	analytics_job_fields	GET /analytics/job-fields	Get the list of job fields.
AnalyticsApi	analytics_jobs	GET /analytics/jobs	Get the list of jobs.
AnalyticsApi	analytics_positions	GET /analytics/positions	Get the list of job positions.
CandidatesApi	candidates_add	POST /candidates	Create a new candidate and assign to a Talent Pool
CandidatesApi	candidates_add_to_job	POST /jobs/{jobId}/candidates	Create a new candidate and assign to a job
CandidatesApi	candidates_all	GET /candidates	Search candidates
CandidatesApi	candidates_attachments_add	POST /candidates/{id}/attachments	Attach files to a candidate.
CandidatesApi	candidates_attachments_get	GET /candidates/{id}/attachments/{attachmentId}	Get a candidate's attachment.
CandidatesApi	candidates_attachments_list	GET /candidates/{id}/attachments	Get list candidate's attachments.
CandidatesApi	candidates_delete	DELETE /candidates/{id}	Delete Candidate
CandidatesApi	candidates_get	GET /candidates/{id}	Get details of a candidate
CandidatesApi	candidates_onboarding_get	GET /candidates/{id}/onboardingStatus	Get Onboarding Status for a candidate
CandidatesApi	candidates_onboarding_get_for_job	GET /candidates/{id}/jobs/{jobId}/onboardingStatus	Get Onboarding Status for a candidate associated with given job
CandidatesApi	candidates_onboarding_update	PUT /candidates/{id}/onboardingStatus	Set Onboarding Status for a candidate
CandidatesApi	candidates_onboarding_update_for_job	PUT /candidates/{id}/jobs/{jobId}/onboardingStatus	Sets Onboarding Status for a candidate associated with given job
CandidatesApi	candidates_properties_get	GET /candidates/{id}/properties	Get candidate property values for a candidate
CandidatesApi	candidates_properties_get_for_job	GET /candidates/{id}/jobs/{jobId}/properties	Get candidate property values for a candidate's job
CandidatesApi	candidates_properties_values_update	PUT /candidates/{id}/properties/{propertyId}	Add/update candidate property value
CandidatesApi	candidates_properties_values_update_for_job	PUT /candidates/{id}/jobs/{jobId}/properties/{propertyId}	Add/update candidate property value
CandidatesApi	candidates_resume_add	POST /candidates/cv	Parse a resume, create a candidate and assign to a Talent Pool.
CandidatesApi	candidates_resume_add_to_job	POST /jobs/{jobId}/candidates/cv	Parse a resume, create a candidate and assign to a job.
CandidatesApi	candidates_screening_answers_get	GET /candidates/{id}/jobs/{jobId}/screening-answers	Get candidate screening answers for a candidate's job
CandidatesApi	candidates_source_update	PUT /candidates/{id}/jobs/{jobId}/source	Update a candidate's source
CandidatesApi	candidates_status_history_get	GET /candidates/{id}/status/history	Get candidate's status history
CandidatesApi	candidates_status_update	PUT /candidates/{id}/jobs/{jobId}/status	Update a candidate's status
CandidatesApi	candidates_status_update_primary	PUT /candidates/{id}/status	Update a candidate's status on primary assignment
CandidatesApi	candidates_tags_add	POST /candidates/{id}/tags	Add tags to a candidate
CandidatesApi	candidates_tags_delete	DELETE /candidates/{id}/tags	Delete tags for a candidate
CandidatesApi	candidates_tags_get	GET /candidates/{id}/tags	Get tags for a candidate
CandidatesApi	candidates_tags_replace	PUT /candidates/{id}/tags	Update tags for a candidate
CandidatesApi	candidates_update	PATCH /candidates/{id}	Update candidate personal information
ConfigurationApi	configuration_candidate_properties_all	GET /configuration/candidate-properties	Get a list of available candidate properties
ConfigurationApi	configuration_candidate_properties_get	GET /configuration/candidate-properties/{id}	Get candidate property by id
ConfigurationApi	configuration_candidate_properties_values_all	GET /configuration/candidate-properties/{id}/values	Get Candidate Property values
ConfigurationApi	configuration_candidate_properties_values_create	POST /configuration/candidate-properties/{id}/values	Create candidate property value
ConfigurationApi	configuration_candidate_properties_values_get	GET /configuration/candidate-properties/{id}/values/{valueId}	Get Candidate Property value by id
ConfigurationApi	configuration_candidate_properties_values_update	PUT /configuration/candidate-properties/{id}/values/{valueId}	Update candidate property value label
ConfigurationApi	configuration_company_my	GET /configuration/company	Get company information
ConfigurationApi	configuration_department_all	GET /configuration/departments	Get departments
ConfigurationApi	configuration_department_create	POST /configuration/departments	Creates department
ConfigurationApi	configuration_department_get	GET /configuration/departments/{id}	Get department
ConfigurationApi	configuration_hiring_process_all	GET /configuration/hiring-processes	Get list of hiring process
ConfigurationApi	configuration_hiring_process_get	GET /configuration/hiring-processes/{id}	Get hiring process
ConfigurationApi	configuration_job_properties_activate	PUT /configuration/job-properties/{id}/activation	Activate a job property
ConfigurationApi	configuration_job_properties_all	GET /configuration/job-properties	Get a list of available job properties
ConfigurationApi	configuration_job_properties_create	POST /configuration/job-properties	Create a job property
ConfigurationApi	configuration_job_properties_deactivate	DELETE /configuration/job-properties/{id}/activation	Deactivate a job property
ConfigurationApi	configuration_job_properties_dependents_all	GET /configuration/job-properties/{id}/dependents	Get job property's dependents
ConfigurationApi	configuration_job_properties_dependents_create	POST /configuration/job-properties/{id}/dependents	Create job property dependents
ConfigurationApi	configuration_job_properties_dependents_remove	DELETE /configuration/job-properties/{id}/dependents/{dependentId}	Remove job property's dependent
ConfigurationApi	configuration_job_properties_dependents_values_add	POST /configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values	Add job property's dependent value
ConfigurationApi	configuration_job_properties_dependents_values_all	GET /configuration/job-properties/{id}/dependents/{dependentId}/values	Get dependent job property's values
ConfigurationApi	configuration_job_properties_dependents_values_get	GET /configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values	Get job property's dependent values
ConfigurationApi	configuration_job_properties_dependents_values_remove	DELETE /configuration/job-properties/{id}/values/{valueId}/dependents/{dependentId}/values/{dependentValueId}	Remove job property's dependent values relationship
ConfigurationApi	configuration_job_properties_get	GET /configuration/job-properties/{id}	Get job property by id
ConfigurationApi	configuration_job_properties_update	PATCH /configuration/job-properties/{id}	Update a job property
ConfigurationApi	configuration_job_properties_values_archive	PUT /configuration/job-properties/{id}/archive-values/{valueId}	Archive a job property value
ConfigurationApi	configuration_job_properties_values_create	POST /configuration/job-properties/{id}/values	Create a job property value
ConfigurationApi	configuration_job_properties_values_deprecated_archive	DELETE /configuration/job-properties/{id}/values/{valueId}	Archive a job property value
ConfigurationApi	configuration_job_properties_values_deprecated_unarchive	PUT /configuration/job-properties/{id}/values/{valueId}	Unarchive a job property value
ConfigurationApi	configuration_job_properties_values_get	GET /configuration/job-properties/{id}/values	Get available job property values
ConfigurationApi	configuration_job_properties_values_unarchive	DELETE /configuration/job-properties/{id}/archive-values/{valueId}	Unarchive a job property value
ConfigurationApi	configuration_job_properties_values_update	PATCH /configuration/job-properties/{id}/values/{valueId}	Update a job property value
ConfigurationApi	configuration_offer_properties_all	GET /configuration/offer-properties	Get a list of available offer properties
ConfigurationApi	configuration_reasons_rejection_all	GET /configuration/rejection-reasons	Get rejection reasons
ConfigurationApi	configuration_reasons_withdrawal_all	GET /configuration/withdrawal-reasons	Get withdrawal reasons
ConfigurationApi	configuration_source_types	GET /configuration/sources	List candidate source types with subtypes
ConfigurationApi	configuration_source_values_all	GET /configuration/sources/{sourceType}/values	List candidate sources
ConfigurationApi	configuration_source_values_single	GET /configuration/sources/{sourceType}/values/{sourceValueId}	Get a candidate source
JobsApi	jobs_all	GET /jobs	Search jobs
JobsApi	jobs_create	POST /jobs	Create a new job
JobsApi	jobs_get	GET /jobs/{id}	Get content of a job with a given id.
JobsApi	jobs_hiring_team_add	POST /jobs/{id}/hiring-team	Add hiring team member of a job with a given id.
JobsApi	jobs_hiring_team_get	GET /jobs/{id}/hiring-team	Get hiring team of a job with a given id.
JobsApi	jobs_hiring_team_remove	DELETE /jobs/{id}/hiring-team/{userId}	Removes hiring team member of a job with a given id.
JobsApi	jobs_jobads_all	GET /jobs/{id}/jobads	Find and list job ads for a given job
JobsApi	jobs_jobads_create	POST /jobs/{id}/jobads	Create a new job ad
JobsApi	jobs_jobads_get	GET /jobs/{id}/jobads/{jobadId}	Get a job ad
JobsApi	jobs_jobads_postings_all	GET /jobs/{id}/jobads/{jobadId}/postings	List publications for a job ad
JobsApi	jobs_jobads_postings_create	POST /jobs/{id}/jobads/{jobadId}/postings	Publishes a job ad
JobsApi	jobs_jobads_postings_unpublish	DELETE /jobs/{id}/jobads/{jobadId}/postings	Unpublish a job ad
JobsApi	jobs_jobads_update	PUT /jobs/{id}/jobads/{jobadId}	Update a job ad
JobsApi	jobs_notes_get	GET /jobs/{id}/note	Get note of a job.
JobsApi	jobs_notes_update	PUT /jobs/{id}/note	Update note of a job.
JobsApi	jobs_patch	PATCH /jobs/{id}	Update a job
JobsApi	jobs_positions_all	GET /jobs/{id}/positions	Positions for a job
JobsApi	jobs_positions_create	POST /jobs/{id}/positions	Create a new position for a job
JobsApi	jobs_positions_get	GET /jobs/{id}/positions/{positionId}	Get a single position
JobsApi	jobs_positions_remove	DELETE /jobs/{id}/positions/{positionId}	Delete position
JobsApi	jobs_positions_update	PUT /jobs/{id}/positions/{positionId}	Update position
JobsApi	jobs_publication_all	GET /jobs/{id}/publication	Find and list publications for a job
JobsApi	jobs_publication_create	POST /jobs/{id}/publication	Publishes a default job ad
JobsApi	jobs_publication_unpublish	DELETE /jobs/{id}/publication	Unpublishes a job from all sources
JobsApi	jobs_status_history_get	GET /jobs/{id}/status/history	Job status history
JobsApi	jobs_status_update	PUT /jobs/{id}/status	Updates job status
JobsApi	jobs_update	PUT /jobs/{id}	Updates job
MessagesApi	messages_shares_create	POST /messages/shares	Shares new messages on Hireloop with Users, Hiring Teams or Everyone and sends emails.
MessagesApi	messages_shares_delete	DELETE /messages/shares/{id}	Delete a message
OffersApi	candidates_offers_all	GET /candidates/{id}/jobs/{jobId}/offers	Get candidate's offers
OffersApi	candidates_offers_find	GET /offers	Search offers
OffersApi	candidates_offers_get	GET /candidates/{id}/jobs/{jobId}/offers/{offerId}	Get candidate's offer
PostingsApi	v1_get_posting	GET /v1/companies/{companyIdentifier}/postings/{postingId}	Get posting by posting id for given company
PostingsApi	v1_list_departments	GET /v1/companies/{companyIdentifier}/departments	List departments for given company
PostingsApi	v1_list_postings	GET /v1/companies/{companyIdentifier}/postings	Lists active postings published by given company
UsersApi	users_activation_activate	PUT /users/{id}/activation	Activate a user
UsersApi	users_activation_deactivate	DELETE /users/{id}/activation	Deactivate a user
UsersApi	users_activation_delete	DELETE /users/{id}	Deactivate a user
UsersApi	users_activation_email_send	POST /users/{id}/activation-email	Send an activation email to a user
UsersApi	users_all	GET /users	List users of your company
UsersApi	users_avatar_update	PUT /users/{id}/avatar	Update user avatar
UsersApi	users_create	POST /users	Create a new user.
UsersApi	users_get	GET /users/{id}	Get details of a user with given id
UsersApi	users_me	GET /users/me	Get details of my user
UsersApi	users_update	PATCH /users/{id}	Update a user

Documentation For Models

Documentation For Authorization

key

Type: API key
API key parameter name: x-smarttoken
Location: HTTP header

Author

Kris Roksela kris@dataservices.pro

yogasukmawijaya/smartrecruiters-python-client