Build with Recuity

Authentication

Every request must include your API key as a request header. Keep it secret and never expose it in client-side code.

X-API-Key: YOUR_API_KEY

You can find your API key in your account settings, under API Keys. Replace YOUR_API_KEY with that value in every example on these pages.

Base URL

Every endpoint path on these pages is written in full, starting with /api/v1. Append it to this base URL.

So GET /api/v1/companies is https://recuity.ai/api/v1/companies.

Make your first request

Start by searching for companies. A brand-new workspace isn't tracking any companies yet, so company search is the one call that returns useful data straight away. It reads from the shared directory as well as your own companies.

Request

curl -X GET \
  "https://recuity.ai/api/v1/companies?q=fintech" \
  -H "X-API-Key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://recuity.ai/api/v1/companies",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"q": "fintech"}
)
data = response.json()

Example response

{
  "companies": [
    {
      "id": "692987bcd5644d953f62cc87",
      "name": "TechCorp Solutions",
      "current_url": "https://techcorp-solutions.com",
      "location": "London, GB",
      "company_type": "Startup",
      "is_tracked": false,
      "is_owned_by_tenant": false
    }
  ],
  "total_results": 20,
  "current_page": 1,
  "has_more": true,
  "page_size": 20
}

Start by searching for a company and choose one to track. Once Recuity has indexed its jobs, you can search them through the Jobs API.

Typical workflow

Explore the API