Deprecation Notice

Merge has released a new version of our Java SDK. As part of that release, we are providing a deprecation notice of our legacy SDKs.

To help give you time to plan your migration to our latest SDK:

• August 2023: SDK deprecation notice on our legacy Java SDKs.
• Until February 2024: we’ll support updates as needed and address bugs in priority order
• After February 2024: we’ll no longer make updates or bug fixes to the deprecated SDKs

For information about the deprecation notice see our help center and for information about migrating to the Java SDK, see the Java Migration Guide.

merge-ats-client

Merge ATS API

• API version: 2.0.0
  • Build date: 2023-01-10T20:13:14.599893Z[Etc/UTC]

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

For more information, please visit https://www.merge.dev/

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>dev.merge.ats</groupId>
  <artifactId>merge-ats-client</artifactId>
  <version>2.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "dev.merge.ats:merge-ats-client:2.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/merge-ats-client-2.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import merge_ats_client.ApiClient;
import merge_ats_client.ApiException;
import merge_ats_client.Configuration;
import merge_ats_client.auth.*;
import merge_ats_client.models.*;
import merge_ats_client.api.AccountDetailsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.merge.dev/api/ats/v1");
    
    // Configure API key authorization: accountTokenAuth
    ApiKeyAuth accountTokenAuth = (ApiKeyAuth) defaultClient.getAuthentication("accountTokenAuth");
    accountTokenAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //accountTokenAuth.setApiKeyPrefix("Token");

    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountDetailsApi apiInstance = new AccountDetailsApi(defaultClient);
    try {
      AccountDetails result = apiInstance.accountDetailsRetrieve();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountDetailsApi#accountDetailsRetrieve");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountDetailsApi	accountDetailsRetrieve	GET /account-details
AccountTokenApi	accountTokenRetrieve	GET /account-token/{public_token}
ActivitiesApi	activitiesList	GET /activities
ActivitiesApi	activitiesRetrieve	GET /activities/{id}
ApplicationsApi	applicationsChangeStageCreate	POST /applications/{id}/change-stage
ApplicationsApi	applicationsCreate	POST /applications
ApplicationsApi	applicationsList	GET /applications
ApplicationsApi	applicationsMetaPostRetrieve	GET /applications/meta/post
ApplicationsApi	applicationsRetrieve	GET /applications/{id}
AttachmentsApi	attachmentsCreate	POST /attachments
AttachmentsApi	attachmentsList	GET /attachments
AttachmentsApi	attachmentsMetaPostRetrieve	GET /attachments/meta/post
AttachmentsApi	attachmentsRetrieve	GET /attachments/{id}
AvailableActionsApi	availableActionsRetrieve	GET /available-actions
CandidatesApi	candidatesCreate	POST /candidates
CandidatesApi	candidatesIgnoreCreate	POST /candidates/ignore/{model_id}
CandidatesApi	candidatesList	GET /candidates
CandidatesApi	candidatesMetaPostRetrieve	GET /candidates/meta/post
CandidatesApi	candidatesRetrieve	GET /candidates/{id}
CommonModelScopesApi	commonModelScopesRetrieve	GET /common-model-scopes
CommonModelScopesApi	commonModelScopesUpdate	PUT /common-model-scopes
DeleteAccountApi	deleteAccountCreate	POST /delete-account
DepartmentsApi	departmentsList	GET /departments
DepartmentsApi	departmentsRetrieve	GET /departments/{id}
EeocsApi	eeocsList	GET /eeocs
EeocsApi	eeocsRetrieve	GET /eeocs/{id}
ForceResyncApi	syncStatusResyncCreate	POST /sync-status/resync
GenerateKeyApi	generateKeyCreate	POST /generate-key
InterviewsApi	interviewsList	GET /interviews
InterviewsApi	interviewsRetrieve	GET /interviews/{id}
IssuesApi	issuesList	GET /issues
IssuesApi	issuesRetrieve	GET /issues/{id}
JobInterviewStagesApi	jobInterviewStagesList	GET /job-interview-stages
JobInterviewStagesApi	jobInterviewStagesRetrieve	GET /job-interview-stages/{id}
JobsApi	jobsList	GET /jobs
JobsApi	jobsRetrieve	GET /jobs/{id}
LinkTokenApi	linkTokenCreate	POST /link-token
LinkedAccountsApi	linkedAccountsList	GET /linked-accounts
OffersApi	offersList	GET /offers
OffersApi	offersRetrieve	GET /offers/{id}
OfficesApi	officesList	GET /offices
OfficesApi	officesRetrieve	GET /offices/{id}
PassthroughApi	passthroughCreate	POST /passthrough
RegenerateKeyApi	regenerateKeyCreate	POST /regenerate-key
RejectReasonsApi	rejectReasonsList	GET /reject-reasons
RejectReasonsApi	rejectReasonsRetrieve	GET /reject-reasons/{id}
ScorecardsApi	scorecardsList	GET /scorecards
ScorecardsApi	scorecardsRetrieve	GET /scorecards/{id}
SelectiveSyncApi	selectiveSyncConfigurationsList	GET /selective-sync/configurations
SelectiveSyncApi	selectiveSyncConfigurationsUpdate	PUT /selective-sync/configurations
SelectiveSyncApi	selectiveSyncMetaList	GET /selective-sync/meta
SyncStatusApi	syncStatusList	GET /sync-status
TagsApi	tagsList	GET /tags
UsersApi	usersList	GET /users
UsersApi	usersRetrieve	GET /users/{id}
WebhookReceiversApi	webhookReceiversCreate	POST /webhook-receivers
WebhookReceiversApi	webhookReceiversList	GET /webhook-receivers

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
• CommonModelScopes
• CommonModelScopesDisabledModels
• CommonModelScopesDisabledModelsEnabledActionsEnum
• CommonModelScopesPutInnerDeserializerEnabledActionsEnum
• CommonModelScopesPutInnerDeserializerRequest
• CommonModelScopesScope
• CommonModelScopesUpdateSerializer
• ConditionSchema
• ConditionTypeEnum
• DataPassthroughRequest
• DebugModeLog
• DebugModelLogSummary
• Department
• DisabilityStatusEnum
• EEOC
• EmailAddress
• EmailAddressRequest
• EmailAddressTypeEnum
• EncodingEnum
• EndUserDetailsRequest
• ErrorValidationProblem
• GenderEnum
• GenerateRemoteKeyRequest
• IgnoreCommonModel
• IgnoreCommonModelRequest
• Issue
• IssueStatusEnum
• Job
• JobInterviewStage
• JobStatusEnum
• LinkToken
• LinkedAccountCondition
• LinkedAccountConditionRequest
• LinkedAccountSelectiveSyncConfiguration
• LinkedAccountSelectiveSyncConfigurationListRequest
• LinkedAccountSelectiveSyncConfigurationRequest
• LinkedAccountStatus
• MetaResponse
• MethodEnum
• ModelOperation
• MultipartFormFieldRequest
• Offer
• OfferStatusEnum
• Office
• OperatorSchema
• OverallRecommendationEnum
• PaginatedAccountDetailsAndActionsList
• PaginatedActivityList
• PaginatedApplicationList
• PaginatedAttachmentList
• PaginatedCandidateList
• PaginatedConditionSchemaList
• PaginatedDepartmentList
• PaginatedEEOCList
• PaginatedIssueList
• PaginatedJobInterviewStageList
• PaginatedJobList
• PaginatedOfferList
• PaginatedOfficeList
• PaginatedRejectReasonList
• PaginatedRemoteUserList
• PaginatedScheduledInterviewList
• PaginatedScorecardList
• PaginatedSyncStatusList
• PaginatedTagList
• PhoneNumber
• PhoneNumberRequest
• PhoneNumberTypeEnum
• RaceEnum
• ReasonEnum
• RejectReason
• RemoteData
• RemoteKey
• RemoteKeyForRegenerationRequest
• RemoteResponse
• RemoteUser
• RequestFormatEnum
• ResponseTypeEnum
• ScheduledInterview
• ScheduledInterviewStatusEnum
• Scorecard
• SelectiveSyncConfigurationsUsageEnum
• SyncStatus
• SyncStatusStatusEnum
• Tag
• TypeEnum
• UpdateApplicationStageRequest
• Url
• UrlRequest
• UrlTypeEnum
• ValidationProblemSource
• VeteranStatusEnum
• VisibilityEnum
• WarningValidationProblem
• WebhookReceiver
• WebhookReceiverRequest

Documentation for Authorization

Authentication schemes defined for the API:

accountTokenAuth

• Type: API key
• API key parameter name: X-Account-Token
• Location: HTTP header

bearerAuth

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]