1.0.0
  • latest
  • 1.0.0
    1.0.0
    • latest
    • 1.0.0
    • Getting Started
      • Generate an API key
    • Recruiting
      • Widget Integration
        • Integration Guide via Widget
        • Embed the Widget Code in WordPress
        • Steps to Implement in a React.js Website
      • Integration via code
        • Integration via code
        • Jobs Listing
    • Company Candidates
      • Company Candidate Sync API
        POST

    Candidates

    You can generate your API key from app.cooperhire.io under the Settings section for your company.
    Need assistance with the integration? We're here to help — contact us anytime at support@cooperhire.io
    💡
    End-of-Life Notice: This API key system will no longer be supported after 15 January 2026. Please ensure you migrate or update your integrations accordingly.
    You must switch to the v2 documentation for the Company Candidate Sync API to continue seamless integration.
    The Candidate Sync API is designed to create candidates for your company in CooperHire through API integrations. This API allows for seamless transfer of candidate information, ensuring that data such as personal details, contact information, resume, documents, and job preferences are accurately captured and synchronized. By utilizing this API, organizations can automate the candidate application process.

    Create an Application#

    When you receive an application from a candidate, please send a POST request to our API as follows:
    Endpoint: https://api.cooperhire.io/v1/company/candidate
    Request Type: POST
    Request Headers: Send api-key in request header.
    Body Type: multipart/form-data
    Body Params: Send the body parameters in the following format. The data type and whether each parameter is required or optional are detailed below.

    Headers Example:#

    Form Data Parameters:#

    Response Codes#

    We have the following types of responses: 401, 200, 422, and 500. The response parameters for each code are detailed below.
    1) Unauthorized: 401
    2) Unprocessable Entity: 422
    3) Success: 200
    4) Internal Server Error: 500
    An unexpected error occurred during the request processing
    5) Unprocessable Entity: 422
    If either job_unique_id or job_id is not provided, the system will return the following error:
    Modified at 2025-11-26 09:24:22
    Previous
    Jobs Listing
    Next
    Company Candidate Sync API
    Built with