@mergeapi/merge_ats_api

merge_ats_api

MergeAtsApi - JavaScript client for merge_ats_api The unified API for building rich integrations with multiple Applicant Tracking System platforms. This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

For Node.js

npm

Install the library via:

npm install @mergeapi/merge_ats_api

Finally, you need to build the module:

npm run build

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var MergeAtsApi = require('merge_ats_api');

var defaultClient = MergeAtsApi.ApiClient.instance;
// Configure API key authorization: tokenAuth
defaultClient.authentications['tokenAuth'] = {type: "bearer", accessToken: "YOUR_API_KEY"}

var api = new MergeAtsApi.AccountTokenApi()
var publicToken = "publicToken_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountTokenRetrieve(publicToken, callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
MergeAtsApi.AccountTokenApi	accountTokenRetrieve	GET /account-token/{public_token}
MergeAtsApi.ActivitiesApi	activitiesList	GET /activities
MergeAtsApi.ActivitiesApi	activitiesRetrieve	GET /activities/{id}
MergeAtsApi.ApplicationsApi	applicationsCreate	POST /applications
MergeAtsApi.ApplicationsApi	applicationsList	GET /applications
MergeAtsApi.ApplicationsApi	applicationsPartialUpdate	PATCH /applications/{id}
MergeAtsApi.ApplicationsApi	applicationsRetrieve	GET /applications/{id}
MergeAtsApi.AttachmentsApi	attachmentsList	GET /attachments
MergeAtsApi.AttachmentsApi	attachmentsRetrieve	GET /attachments/{id}
MergeAtsApi.AvailableActionsApi	availableActionsRetrieve	GET /available-actions
MergeAtsApi.CandidatesApi	candidatesCreate	POST /candidates
MergeAtsApi.CandidatesApi	candidatesList	GET /candidates
MergeAtsApi.CandidatesApi	candidatesRetrieve	GET /candidates/{id}
MergeAtsApi.DepartmentsApi	departmentsList	GET /departments
MergeAtsApi.DepartmentsApi	departmentsRetrieve	GET /departments/{id}
MergeAtsApi.EeocsApi	eeocsList	GET /eeocs
MergeAtsApi.EeocsApi	eeocsRetrieve	GET /eeocs/{id}
MergeAtsApi.GenerateKeyApi	generateKeyCreate	POST /generate-key
MergeAtsApi.InterviewsApi	interviewsList	GET /interviews
MergeAtsApi.InterviewsApi	interviewsRetrieve	GET /interviews/{id}
MergeAtsApi.JobInterviewStagesApi	jobInterviewStagesList	GET /job-interview-stages
MergeAtsApi.JobInterviewStagesApi	jobInterviewStagesRetrieve	GET /job-interview-stages/{id}
MergeAtsApi.JobsApi	jobsList	GET /jobs
MergeAtsApi.JobsApi	jobsRetrieve	GET /jobs/{id}
MergeAtsApi.LinkTokenApi	linkTokenCreate	POST /link-token
MergeAtsApi.OffersApi	offersList	GET /offers
MergeAtsApi.OffersApi	offersRetrieve	GET /offers/{id}
MergeAtsApi.OfficesApi	officesList	GET /offices
MergeAtsApi.OfficesApi	officesRetrieve	GET /offices/{id}
MergeAtsApi.PassthroughApi	passthroughCreate	POST /passthrough
MergeAtsApi.RegenerateKeyApi	regenerateKeyCreate	POST /regenerate-key
MergeAtsApi.RejectReasonsApi	rejectReasonsList	GET /reject-reasons
MergeAtsApi.RejectReasonsApi	rejectReasonsRetrieve	GET /reject-reasons/{id}
MergeAtsApi.ScorecardsApi	scorecardsList	GET /scorecards
MergeAtsApi.ScorecardsApi	scorecardsRetrieve	GET /scorecards/{id}
MergeAtsApi.SyncStatusApi	syncStatusRetrieve	GET /sync-status
MergeAtsApi.TagsApi	tagsList	GET /tags
MergeAtsApi.UsersApi	usersList	GET /users
MergeAtsApi.UsersApi	usersRetrieve	GET /users/{id}

Documentation for Models

• MergeAtsApi.AccessRoleEnum
• MergeAtsApi.AccountIntegration
• MergeAtsApi.AccountToken
• MergeAtsApi.Activity
• MergeAtsApi.ActivityTypeEnum
• MergeAtsApi.Application
• MergeAtsApi.ApplicationRequest
• MergeAtsApi.Attachment
• MergeAtsApi.AvailableActions
• MergeAtsApi.Candidate
• MergeAtsApi.CandidateRequest
• MergeAtsApi.DataPassthroughRequest
• MergeAtsApi.Department
• MergeAtsApi.DisabilityStatusEnum
• MergeAtsApi.EEOC
• MergeAtsApi.EmailAddress
• MergeAtsApi.EmailAddressRequest
• MergeAtsApi.EmailAddressTypeEnum
• MergeAtsApi.EndUserDetailsRequest
• MergeAtsApi.GenderEnum
• MergeAtsApi.GenerateRemoteKeyRequest
• MergeAtsApi.Job
• MergeAtsApi.JobInterviewStage
• MergeAtsApi.JobStatusEnum
• MergeAtsApi.LinkToken
• MergeAtsApi.MethodEnum
• MergeAtsApi.ModelOperation
• MergeAtsApi.Offer
• MergeAtsApi.OfferStatusEnum
• MergeAtsApi.Office
• MergeAtsApi.OverallRecommendationEnum
• MergeAtsApi.PaginatedActivityList
• MergeAtsApi.PaginatedApplicationList
• MergeAtsApi.PaginatedAttachmentList
• MergeAtsApi.PaginatedCandidateList
• MergeAtsApi.PaginatedDepartmentList
• MergeAtsApi.PaginatedEEOCList
• MergeAtsApi.PaginatedJobInterviewStageList
• MergeAtsApi.PaginatedJobList
• MergeAtsApi.PaginatedOfferList
• MergeAtsApi.PaginatedOfficeList
• MergeAtsApi.PaginatedRejectReasonList
• MergeAtsApi.PaginatedRemoteUserList
• MergeAtsApi.PaginatedScheduledInterviewList
• MergeAtsApi.PaginatedScorecardList
• MergeAtsApi.PaginatedTagList
• MergeAtsApi.PatchedApplicationRequest
• MergeAtsApi.PhoneNumber
• MergeAtsApi.PhoneNumberRequest
• MergeAtsApi.PhoneNumberTypeEnum
• MergeAtsApi.RaceEnum
• MergeAtsApi.RejectReason
• MergeAtsApi.RemoteData
• MergeAtsApi.RemoteDataRequest
• MergeAtsApi.RemoteKey
• MergeAtsApi.RemoteKeyForRegenerationRequest
• MergeAtsApi.RemoteResponse
• MergeAtsApi.RemoteUser
• MergeAtsApi.ScheduledInterview
• MergeAtsApi.ScheduledInterviewStatusEnum
• MergeAtsApi.Scorecard
• MergeAtsApi.SyncStatus
• MergeAtsApi.Tag
• MergeAtsApi.Url
• MergeAtsApi.UrlRequest
• MergeAtsApi.UrlTypeEnum
• MergeAtsApi.VeteranStatusEnum
• MergeAtsApi.VisibilityEnum

Documentation for Authorization

tokenAuth

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