Recruspace
    Recruspace
    • Welcome
    • Get API Key
    • Authentication
    • Rate Limit
    • Pagination
    • Endpoints
      • Get Candidate
        GET
      • Create Candidate
        POST
      • Add Note to Candidate
        POST
      • Add Tag to Candidate
        POST
      • Add Candidate to Job Post or Talent Pool
        POST
      • Search Candidate by Email
        GET
      • List Company Offices
        GET
      • List Company Users
        GET
      • List Job Posts
        GET
      • Get Job Post
        GET
      • Apply to Job Post
        POST
      • List Job Post Questions
        GET
      • List Talent Pools
        GET
      • Update Talent Pool
        PATCH
      • Delete Talent Pool
        DELETE
      • List Talent Pool Candidates
        GET
      • Create Talent Pool
        POST
      • Upload File
        POST

    Authentication

    All requests to the Recruspace API must be authenticated using an API Key. This key ensures that only authorized clients can access the API resources.

    ๐Ÿ“Œ How It Works#

    You must include the following HTTP header in every API request:
    Authorization: Bearer <your-api-key>
    
    Replace <your-api-key> with your actual API Key.
    API Keys are typically issued via the Recruspace dashboard or by your system administrator.
    API Keys must be kept confidential and should never be hardcoded in public code repositories.

    ๐Ÿงช Example Request (cURL)#


    ๐Ÿšซ Invalid or Missing API Key#

    If the API Key is missing or invalid, the API will return a 401 Unauthorized response:
    {
      "detail": "Authentication credentials were not provided."
    }

    ๐Ÿ›ก๏ธ Best Practices#

    Do not expose your API Key in public code, client-side apps, or version control.
    Rotate API Keys regularly for security.
    Use environment variables or a secrets management system to store your API Key securely.

    โ— Your API Key is sensitive. Keep it secret and do not share it publicly.
    Modified atย 2025-05-13 08:00:28
    Previous
    Get API Key
    Next
    Rate Limit
    Built with