MergeATSClient

The unified API for building rich integrations with multiple Applicant Tracking System platforms.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.2.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.merge.dev/

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/merge-api/merge-ats-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/merge-api/merge-ats-python.git)

Then import the package:

import MergeATSClient

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 MergeATSClient

Getting Started

Please follow the installation procedure and then run the following:

import time
import MergeATSClient
from pprint import pprint
from MergeATSClient.api import account_details_api
from MergeATSClient.model.account_details import AccountDetails
# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeATSClient.Configuration(
    host = "https://api.merge.dev/api/ats/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with MergeATSClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = account_details_api.AccountDetailsApi(api_client)
    
    try:
        api_response = api_instance.account_details_retrieve()
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling AccountDetailsApi->account_details_retrieve: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.merge.dev/api/ats/v1

Class	Method	HTTP request	Description
AccountDetailsApi	account_details_retrieve	GET /account-details
AccountTokenApi	account_token_retrieve	GET /account-token/{public_token}
ActivitiesApi	activities_list	GET /activities
ActivitiesApi	activities_retrieve	GET /activities/{id}
ApplicationsApi	applications_create	POST /applications
ApplicationsApi	applications_list	GET /applications
ApplicationsApi	applications_retrieve	GET /applications/{id}
AttachmentsApi	attachments_create	POST /attachments
AttachmentsApi	attachments_list	GET /attachments
AttachmentsApi	attachments_retrieve	GET /attachments/{id}
AvailableActionsApi	available_actions_retrieve	GET /available-actions
CandidatesApi	candidates_create	POST /candidates
CandidatesApi	candidates_list	GET /candidates
CandidatesApi	candidates_retrieve	GET /candidates/{id}
DeleteAccountApi	delete_account_create	POST /delete-account
DepartmentsApi	departments_list	GET /departments
DepartmentsApi	departments_retrieve	GET /departments/{id}
EeocsApi	eeocs_list	GET /eeocs
EeocsApi	eeocs_retrieve	GET /eeocs/{id}
GenerateKeyApi	generate_key_create	POST /generate-key
InterviewsApi	interviews_list	GET /interviews
InterviewsApi	interviews_retrieve	GET /interviews/{id}
IssuesApi	issues_list	GET /issues
IssuesApi	issues_retrieve	GET /issues/{id}
JobInterviewStagesApi	job_interview_stages_list	GET /job-interview-stages
JobInterviewStagesApi	job_interview_stages_retrieve	GET /job-interview-stages/{id}
JobsApi	jobs_list	GET /jobs
JobsApi	jobs_retrieve	GET /jobs/{id}
LinkTokenApi	link_token_create	POST /link-token
LinkedAccountsApi	linked_accounts_list	GET /linked-accounts
OffersApi	offers_list	GET /offers
OffersApi	offers_retrieve	GET /offers/{id}
OfficesApi	offices_list	GET /offices
OfficesApi	offices_retrieve	GET /offices/{id}
PassthroughApi	passthrough_create	POST /passthrough
RegenerateKeyApi	regenerate_key_create	POST /regenerate-key
RejectReasonsApi	reject_reasons_list	GET /reject-reasons
RejectReasonsApi	reject_reasons_retrieve	GET /reject-reasons/{id}
ScorecardsApi	scorecards_list	GET /scorecards
ScorecardsApi	scorecards_retrieve	GET /scorecards/{id}
SyncStatusApi	sync_status_list	GET /sync-status
SyncStatusApi	sync_status_resync_create	POST /sync-status/resync
TagsApi	tags_list	GET /tags
UsersApi	users_list	GET /users
UsersApi	users_retrieve	GET /users/{id}

Documentation For Models

• AccessRoleEnum
• AccountDetails
• AccountDetailsAndActions
• AccountDetailsAndActionsIntegration
• AccountDetailsAndActionsStatusEnum
• AccountIntegration
• AccountToken
• Activity
• ActivityTypeEnum
• Application
• ApplicationEndpointRequest
• ApplicationRequest
• ApplicationResponse
• Attachment
• AttachmentEndpointRequest
• AttachmentRequest
• AttachmentResponse
• AttachmentTypeEnum
• AvailableActions
• Candidate
• CandidateEndpointRequest
• CandidateRequest
• CandidateResponse
• CategoriesEnum
• CategoryEnum
• DataPassthroughRequest
• Department
• DisabilityStatusEnum
• EEOC
• EmailAddress
• EmailAddressRequest
• EmailAddressTypeEnum
• EndUserDetailsRequest
• GenderEnum
• GenerateRemoteKeyRequest
• Issue
• IssueStatusEnum
• Job
• JobInterviewStage
• JobStatusEnum
• LinkToken
• MethodEnum
• ModelOperation
• Offer
• OfferStatusEnum
• Office
• OverallRecommendationEnum
• PaginatedAccountDetailsAndActionsList
• PaginatedActivityList
• PaginatedApplicationList
• PaginatedAttachmentList
• PaginatedCandidateList
• PaginatedDepartmentList
• PaginatedEEOCList
• PaginatedIssueList
• PaginatedJobInterviewStageList
• PaginatedJobList
• PaginatedOfferList
• PaginatedOfficeList
• PaginatedRejectReasonList
• PaginatedRemoteUserList
• PaginatedScheduledInterviewList
• PaginatedScorecardList
• PaginatedSyncStatusList
• PaginatedTagList
• PhoneNumber
• PhoneNumberRequest
• PhoneNumberTypeEnum
• RaceEnum
• RejectReason
• RemoteData
• RemoteDataRequest
• RemoteKey
• RemoteKeyForRegenerationRequest
• RemoteResponse
• RemoteUser
• RequestFormatEnum
• ScheduledInterview
• ScheduledInterviewStatusEnum
• Scorecard
• SyncStatus
• SyncStatusStatusEnum
• Tag
• Url
• UrlRequest
• UrlTypeEnum
• ValidationProblem
• VeteranStatusEnum
• VisibilityEnum

Documentation For Authorization

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

[email protected]

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in MergeATSClient.apis and MergeATSClient.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from MergeATSClient.api.default_api import DefaultApi
• from MergeATSClient.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import MergeATSClient
from MergeATSClient.apis import *
from MergeATSClient.models import *