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: /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>

Sections