OORWIN LABS INC

OORWIN V1 API Reference

Authentication

Accounts

Account Save

Contacts

Contact Save

Jobs

Candidates

Pipeline

Submissions

Interviews

Perm Placements

Resouce Pool

Employees

Assignments

Timesheets

Default

Apiv2

Production

Sandbox

<p class="slate-p " ><strong class="slate-bold">Overview</strong> </p><p class="slate-p " ><br><br>Welcome to the OORWIN API Integration Guide. The OORWIN V1 API allows developers and organizations to seamlessly connect, extract data, and build custom solutions on top of the OORWIN platform. Supported resources include Jobs, Candidates, Pipeline, Submissions, Accounts, Contacts, Interviews, and Perm Placements.<br></p><p class="slate-p " ><br><strong class="slate-bold">Developer Navigation &amp; Setup</strong> </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">API Portal Location: The OORWIN Open API developer platform can be accessed at https://app.oorwin.com/developer.html.</div></li><li class="slate-li " ><div style="position:relative">Protocol &amp; Security: All requests must be transmitted securely over HTTPS. Plain HTTP requests are rejected.</div></li><li class="slate-li " ><div style="position:relative">Encrypted Identifiers: OORWIN utilizes encrypted IDs across resources to ensure robust data security. </div></li><li class="slate-li " ><div style="position:relative">Rate Limits: API rate limits apply per user authentication token. When a limit is breached, the API returns an HTTP 400 error status code</div></li></ul><p class="slate-p " ><br><strong class="slate-bold">Key integration notes </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Rate limiting is applied per user authentication token and covers all authenticated endpoints. Once the rate limit is reached, the API returns an HTTP 400 error code. </div></li><li class="slate-li " ><div style="position:relative"> All API requests must be made over HTTPS. Calls made over plain HTTP will fail. </div></li><li class="slate-li " ><div style="position:relative"> All endpoints use encrypted IDs to enhance data security. Contact your OORWIN account representative to have API credentials (client secret) generated for your account before you begin integration. </div></li><li class="slate-li " ><div style="position:relative"> Every authenticated endpoint (all endpoints except Login) requires an Authorization header containing a Bearer token obtained from the Login endpoint. </div></li><li class="slate-li " ><div style="position:relative">Supported request and response code samples on the OORWIN developer portal include cURL, Ruby, Python, PHP, Java, Node.js, Go, and .NET. </div></li></ul><p class="slate-p " ><strong class="slate-bold">Base URLs </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Production: https://api.oorwin.ai/api/v2 </div></li><li class="slate-li " ><div style="position:relative">Sandbox: https://api.oorwin.info/api/v2 <br><br><br></div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>



Welcome to the OORWIN API Integration Guide. The OORWIN V1 API allows developers and organizations to seamlessly connect, extract data, and build custom solutions on top of the OORWIN platform. Supported resources include Jobs, Candidates, Pipeline, Submissions, Accounts, Contacts, Interviews, and Perm Placements.


<p class="slate-p " ></p><p class="slate-p " >Method: POST </p><p class="slate-p " >Endpoint: /login </p><p class="slate-p " >Purpose: Authenticates user credentials and returns a persistent Bearer access token. </p><p class="slate-p " ><strong class="slate-bold">Developer Guide / Steps</strong><strong class="slate-bold"></strong><strong class="slate-bold">:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Obtain Client Secret: Contact your OORWIN Account Manager to obtain a unique Client Secret key. </div></li><li class="slate-li " ><div style="position:relative">Credentials Requirement: Provide your registered account email (preferably admin or super admin), password, and client secret. </div></li><li class="slate-li " ><div style="position:relative">Token Lifecycle: Upon successful compilation and validation, the system generates an access token. This token does NOT expire. - Usage: Store the token securely and include it as a Bearer token in the Authorization header for all authenticated endpoints.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Body Parameters (JSON): </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">email (string, REQUIRED) — Registered account email address.</div></li><li class="slate-li " ><div style="position:relative"> password (string, REQUIRED) — Account password. </div></li><li class="slate-li " ><div style="position:relative">client_secret (string, REQUIRED) — Client secret provided by OORWIN.</div></li></ul><p class="slate-p " ></p>

Purpose: Authenticates user credentials and returns a persistent Bearer access token. 

email

password

client_secret

<p class="slate-p " >Method: POST </p><p class="slate-p " >Endpoint: /candidates</p><p class="slate-p " >Purpose: Retrieves a paginated list of candidate profiles. </p><p class="slate-p " ><strong class="slate-bold">Developer Guide / Steps</strong>:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigation: Navigate to &quot;Candidates &gt; List Candidates&quot;.</div></li><li class="slate-li " ><div style="position:relative">Filter Options:  Leverage the 5 core filters to customize your query: </div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Default Search: Search across candidate full name, first name, last name, email address, or phone number with country code. </div></li><li class="slate-li " ><div style="position:relative">Limit, Order, Page, Sort: Control pagination and sorting order.</div></li><li class="slate-li " ><div style="position:relative"> View Name: Supply the name of a saved custom candidate view/folder to filter by pre-saved criteria. </div></li></ul></li></ul><p class="slate-p " ><strong class="slate-bold">Body Parameters (JSON): </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">default_search_filter (string, OPTIONAL) — Search string for candidate name, email, or phone.</div></li><li class="slate-li " ><div style="position:relative">limit (number, OPTIONAL) — Records per page</div></li><li class="slate-li " ><div style="position:relative">order, page, sort (string/number, OPTIONAL) — Pagination/sorting options </div></li><li class="slate-li " ><div style="position:relative">view_name (string, OPTIONAL) — Saved custom view folder name </div></li></ul><p class="slate-p " ></p>

Purpose: Retrieves a paginated list of candidate profiles. 

default_search_filter

limit

order

page

sort

view_name

Authorization

<p class="slate-p " >Method: POST <br>Endpoint: /candidates/saveApiCandidate<br>Purpose: Creates a new candidate profile in OORWIN. </p><p class="slate-p " ><strong class="slate-bold">Developer Guide / Steps:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> Navigation: Navigate to &quot;Candidates &gt; Candidate Save&quot;. </div></li><li class="slate-li " ><div style="position:relative">Mandatory Email: The candidate&apos;s &quot;email&quot; address is strictly REQUIRED. </div></li><li class="slate-li " ><div style="position:relative">Resume Attachment: To attach a resume, you MUST encode the binary file data into a Base64 string and pass it in &quot;ResmeFileData&quot;, accompanied by the exact filename in &quot;ResumeFileName&quot;.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Header Parameters: </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigation: Navigate to &quot;Candidates &gt; Candidate Save&quot;. </div></li></ul><p class="slate-p " ><strong class="slate-bold">Body Parameters (Form Data): </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">email (text, REQUIRED) — Candidate email address </div></li><li class="slate-li " ><div style="position:relative">firstName, middleName, lastName (text, OPTIONAL) — Name details </div></li><li class="slate-li " ><div style="position:relative">phone, mobile (text, OPTIONAL) — Phone numbers </div></li><li class="slate-li " ><div style="position:relative">employer, title (text, OPTIONAL) — Current employer and job title </div></li><li class="slate-li " ><div style="position:relative">source, candidateStatus, skills, workAuthorization (text, OPTIONAL) — Background information </div></li><li class="slate-li " ><div style="position:relative">ResumeFileName (text, OPTIONAL) — Resume file name with extension </div></li><li class="slate-li " ><div style="position:relative">ResmeFileData (text, OPTIONAL) — Base64-encoded resume file content </div></li><li class="slate-li " ><div style="position:relative">RecruiterEmailID (text, OPTIONAL) — Assigned recruiter email</div></li></ul><p class="slate-p " ></p>

Method: POST 
Endpoint: /candidates/saveApiCandidate
Purpose: Creates a new candidate profile in OORWIN. 

Candidate Save

firstName

middleName

lastName

dateOfBirth

phone

mobile

candidateStatus

address

city

country

state

zipCode

skills

workAuthorization

source

experience

jobTitle

willingToRelocate

employmentType

securityClearance

profileSummary

linkedinUrl

facebookUrl

expectedPayType

expectedPayRate

remoteStatus

gender

currentPayType

currentPayRate

languagesKnown

alternateEmail

softSkills

employer

title

workStartDate

workEndDate

workState

workCity

workCountry

ResumeFileName

For file data, base64-encoded format text is needed.

ResmeFileData

RecruiterEmailID

<p class="slate-p " >Method: POST </p><p class="slate-p " >Endpoint: /notes/saveCandidateNote </p><p class="slate-p " >Purpose: Appends a note to a candidate record and sends notifications. </p><p class="slate-p " ><strong class="slate-bold">Developer Guide / Steps: </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> Navigation: Navigate to &quot;Candidates &gt; Candidate Note save&quot;. </div></li><li class="slate-li " ><div style="position:relative">Target Identification: The &quot;candidateEmail&quot; is REQUIRED to identify the candidate.</div></li><li class="slate-li " ><div style="position:relative">Multiple Notifications: In &quot;notifyEmail&quot;, pass a comma-separated list of recruiter emails to notify them automatically. </div></li></ul><div class="slate-div"></div><p class="slate-p " ><strong class="slate-bold">Header Parameters: </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> Authorization (string, REQUIRED) — Bearer token </div></li></ul><p class="slate-p " ><strong class="slate-bold">Body Parameters (Form Data): </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> candidate_id (text, REQUIRED) — Encrypted Candidate ID </div></li><li class="slate-li " ><div style="position:relative">All other fields match Candidate Save (firstName, skills, lastSource, etc.) and are OPTIONAL. </div></li></ul><p class="slate-p " ></p>

Purpose: Appends a note to a candidate record and sends notifications. 

Candidate Update

candidate_id

lastSource

Candidate Note Save

candidateEmail

noteType

Give comma-separated email addresses for recruiters.

notifyEmail

Description

<p class="slate-p " >Method: POST </p><p class="slate-p " >Endpoint: /candidates/getApiCandidateResume </p><p class="slate-p " >Purpose: Retrieves the resume document for a specified candidate. </p><p class="slate-p " ><strong class="slate-bold">Developer Guide / Steps: </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> Supply &quot;candidate_id&quot; to fetch the stored resume file data. </div></li></ul><p class="slate-p " ><strong class="slate-bold">Header Parameters:</strong> </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> Supply &quot;candidate_id&quot; to fetch the stored resume file data. </div></li></ul><p class="slate-p " ></p>

Endpoint: /candidates/getApiCandidateResume 

Purpose: Retrieves the resume document for a specified candidate. 

Get Candidate Resume

<p class="slate-p " >Method: POST </p><p class="slate-p " >Endpoint: /getApiCandidateCustomViews </p><p class="slate-p " >Purpose: Fetches custom views and candidate folders configured in OORWIN. </p><p class="slate-p " ><strong class="slate-bold">De</strong><strong class="slate-bold"></strong><strong class="slate-bold">veloper Guide / S</strong><strong class="slate-bold"></strong><strong class="slate-bold">teps: </strong></p><p class="slate-p " ></p>

Purpose: Fetches custom views and candidate folders configured in OORWIN. 

Get Candidates Folders

<p class="slate-p " >Method: POST </p><p class="slate-p " >Endpoint: /oneTimePlacement/getList </p><p class="slate-p " >Purpose: Retrieves a paginated list of permanent placement records.</p><p class="slate-p " ><strong class="slate-bold">Developer Guide / Steps: </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Navigation: Navigate to &quot;Perm Placements &gt; Perm Placements&quot;.</div></li><li class="slate-li " ><div style="position:relative">Querying: Utilize search filters and pagination parameters to query records. </div></li></ul><p class="slate-p " ><strong class="slate-bold">Header Parameters: </strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Authorization (string, REQUIRED) — Bearer token </div></li></ul><p class="slate-p " ><strong class="slate-bold">Body Parameters (</strong><strong class="slate-bold">JSON):</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">default_search_filter (string, OPTIONAL) — Search string </div></li><li class="slate-li " ><div style="position:relative">limit, order, page, sort (number/string, OPTIONAL) — Pagination controls</div></li></ul><p class="slate-p " ></p>

Purpose: Retrieves a paginated list of permanent placement records.

Sections