Developers
Open Swarmhit
DocumentationAPI Reference
Database
POST
/database/companies/search

Search the company database by named filters. At least one filter is required; unknown filter keys are rejected. Every result returned consumes workspace AI credits. Paginate by passing the returned nextCursor back as cursor.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings → API & Webhooks.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/database/companies/search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "industries": [        "Software Development"      ],      "countries": [        "USA"      ],      "minHeadcount": 50    },    "sort": {      "key": "headcount",      "dir": "desc"    },    "limit": 25  }'
{  "data": [    {      "id": 0,      "name": "string",      "domain": "string",      "website": "string",      "linkedinUrl": "string",      "description": "string",      "companyType": "string",      "yearFounded": 0,      "industry": "string",      "industries": [        "string"      ],      "headcount": 0,      "headcountRange": "string",      "headcountGrowth12m": 0,      "country": "string",      "headquarters": "string",      "funding": {        "totalUsd": 0,        "lastRoundUsd": 0,        "lastRoundType": "string",        "lastRoundDate": "string",        "investors": [          "string"        ]      },      "followers": 0,      "openings": 0,      "estimatedRevenue": {        "minUsd": 0,        "maxUsd": 0      }    }  ],  "paging": {    "nextCursor": "string",    "totalCount": 0  }}

Enrich a person POST

Full database profile for one person, from their LinkedIn URL: experience, education, skills, follower counts, and with `includeEmail` their verified business email. Consumes workspace AI credits (more with `includeEmail`). Without `includeEmail` the response omits the `contact` availability flags.

Search people in the database POST

Search the people database by named filters. At least one filter is required; unknown filter keys are rejected. Array filters match any of their values; text filters are fuzzy. Every result returned consumes workspace AI credits. Paginate by passing the returned `nextCursor` back as `cursor` (filters must stay identical between pages).