Skip to main content

Endpoints


List companies

GET /api/v2/companies

Query parameters

keyword
string
Search by company name or domain (e.g. "Acme" or "acme.com").
page
number
Page number (default: 1).
limit
number
Results per page (default: 10).

Response

results
array
Array of company objects.
totalRecords
number
Total matching companies.
totalPages
number
Total pages at the current limit.
Response 200

Create a company

POST /api/v2/companies
domain
string
required
Company domain (e.g. acme.com). Also used as name when name is omitted.
name
string
Company display name. Defaults to domain when not provided.
website
string
Full website URL (e.g. https://acme.com).
Example

Response

Response 201