Companies API
API Reference
The reference below covers every endpoint in the Companies API. Code examples are generated automatically; the live playground is disabled to prevent accidental writes to production from the docs site.
POST
/api/v1/companiesAuthorization
BearerAuth AuthorizationBearer <token>
Pass an API key issued from the agentlyleads workspace settings.
Example: Authorization: Bearer alk_live_xxxxxxxxxxxx
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
application/json
curl -X POST "https://example.com/api/v1/companies" \ -H "Content-Type: application/json" \ -d '{ "companies": [ { "name": "Acme Corp", "domain": "acme.com", "industry": "Retail", "externalId": "SHOP-CO-1" } ] }'{ "created": 1, "updated": 1, "errors": 0, "results": [ { "index": 0, "status": "created", "id": "018e2a4b-0000-7000-8000-aabbccddeeff" }, { "index": 1, "status": "updated", "id": "018e2a4b-1111-7000-8000-aabbccddeeff" } ]}{ "created": 1, "updated": 0, "errors": 1, "results": [ { "index": 0, "status": "created", "id": "018e2a4b-0000-7000-8000-aabbccddeeff" }, { "index": 1, "status": "error", "error": "name: String must contain at least 1 character(s)" } ]}{ "error": "companies must not be empty."}{ "error": "Invalid or missing API key."}{ "error": "API key missing required scope: write:products."}{ "error": "Rate limit exceeded."}