# Company Employees

> Retrieve public employee profiles for a company.

- **Endpoint:** `POST https://api.nyne.ai/company/employees`
- **Group:** Company APIs (https://api.nyne.ai/documentation/company.md)
- **Auth:** `X-API-Key` + `X-API-Secret` headers
- **Mode:** Asynchronous - submit returns a `request_id` (normally with `202 Accepted`); poll `GET /company/employees?request_id=<request_id>` with the same auth headers until the endpoint reports a terminal response. Where supported, a `callback_url` can notify you when queued work finishes; follow this endpoint's retrieval notes.
- **HTML version:** https://api.nyne.ai/documentation/company/employees

Return a broad roster of public employee profiles for one company, identified by a `company_name`, `domain`, or company `social_media_url` (supply at least one). Use `/person/search` instead when you need title, role, location, experience, or other person-level criteria. Results come back as a `results` array of person-shaped objects with profile links, headlines, locations, organizations, and related fields when available. The request is queued asynchronously and returns a `request_id`; poll or supply a `callback_url`. Credits are charged only for profiles returned.

## Authentication

All `/person/*` and `/company/*` endpoints authenticate with an API key and secret sent as HTTP headers on every request: `X-API-Key` and `X-API-Secret`. Create keys from your Nyne.ai dashboard and keep the secret server-side. Rate limits: 100 requests/minute, 1,000 requests/hour. Full guide: https://api.nyne.ai/documentation/authentication.md

## Parameters

| Name | Type | Required | Description | Example |
| --- | --- | --- | --- | --- |
| `company_name` | string | no | Company name. One of company_name / domain / social_media_url is required. Max 255 chars. | "Acme" |
| `domain` | string | no | Company domain or website hostname. Scheme, path, and `www.` are removed automatically. Max 255 chars. | "acme.com" |
| `social_media_url` | string | no | Company social media URL. Query strings and fragments are stripped before processing. Max 2048 chars. | "https://www.linkedin.com/company/acme/" |
| `max_employees` | integer | no | Maximum profiles to return. Range 1-500, default 10. | 25 |
| `callback_url` | string | no | http(s) URL on an allowed host that receives the completed payload automatically. | "https://example.com/webhook/company-employees" |

## Polling for the result

A newly queued submit normally returns `202 Accepted` with a `request_id`. Poll the same path until `status` is `completed` (results stay available afterwards). Where supported, pass a `callback_url` on the submit to receive a webhook when queued work finishes; keep the documented GET as a recovery and retrieval path:

```bash
curl "https://api.nyne.ai/company/employees?request_id=<request_id>" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"
```

## Credit usage

| Item | Credits | Condition |
| --- | --- | --- |
| Company Employees | 1 | Charged per profile returned (per-result) |
| No profiles | 0 | No employee data found never burns per-result credits |

## Responses

| Code | Meaning |
| --- | --- |
| `202` | Request queued - poll the status endpoint with the returned request_id |
| `400` | missing_parameters / invalid_url / invalid_domain / invalid_parameters / invalid_callback_url |
| `401` | Missing or invalid API credentials |
| `402` | insufficient_credits |
| `403` | subscription_required or ip_not_allowed |
| `429` | rate_limit_exceeded / monthly_limit_exceeded |
| `503` | service_unavailable - the API is temporarily unavailable |

## Example request

### cURL

```bash
curl -X POST https://api.nyne.ai/company/employees \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme",
    "domain": "acme.com",
    "max_employees": 25
  }'
```

### Python

```python
import requests

resp = requests.post(
    "https://api.nyne.ai/company/employees",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "X-API-Secret": "YOUR_API_SECRET",
    },
    json={
        "company_name": "Acme",
        "domain": "acme.com",
        "max_employees": 25,
    },
)
data = resp.json()
print(data)
```

### Node

```javascript
const resp = await fetch("https://api.nyne.ai/company/employees", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "X-API-Secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    company_name: "Acme",
    domain: "acme.com",
    max_employees: 25,
  }),
});
const data = await resp.json();
console.log(data);
```

### PHP

```php
<?php
$ch = curl_init("https://api.nyne.ai/company/employees");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "X-API-Key: YOUR_API_KEY",
    "X-API-Secret: YOUR_API_SECRET",
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
    "company_name" => "Acme",
    "domain" => "acme.com",
    "max_employees" => 25,
  ]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);
```

## Example response

```json
{
  "request_id": "94f1bf8a0d1a1f065a9b4e7fbc3df6aa_1700000123_2210",
  "status": "completed",
  "completed": true,
  "result": {
    "results": [
      {
        "profile_id": "a1b2c3d4e5f6",
        "displayname": "Jane Doe",
        "headline": "VP of Sales at Acme",
        "bio": "Sales leader focused on B2B SaaS go-to-market.",
        "address": {
          "city": "San Francisco",
          "state": "CA",
          "country": "United States"
        },
        "organizations": [
          {
            "name": "Acme",
            "title": "VP of Sales",
            "is_current": true
          }
        ],
        "websites": [
          "https://janedoe.com"
        ],
        "social_profiles": {
          "linkedin": {
            "url": "https://linkedin.com/in/janedoe"
          }
        }
      }
    ],
    "total_results": 1
  },
  "completed_on": "2026-01-15T10:35:00Z"
}
```

---

All documentation pages are available as Markdown by appending `.md` to their URL. Index: https://api.nyne.ai/llms.txt