Companies
The Companies API allows you to create, read, and update company records. Companies can be linked to people and support custom fields and nested notes.
List Companies
GET /api/companies
Retrieves a paginated list of companies in your organization.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit |
integer | No | Number of companies to return (1-100, default: 50) |
offset |
integer | No | Number of companies to skip (default: 0) |
search |
string | No | Search by name, industry, or website |
Response
Success Response (200)
{
"success": true,
"data": {
"companies": [
{
"id": "company-uuid",
"name": "Acme Inc",
"description": "Enterprise software company",
"website": "https://acme.com",
"industry": "Technology",
"address": "456 Market St, San Francisco, CA 94102",
"customFields": {
"cf_tier": "Enterprise"
},
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
],
"total": 42,
"limit": 50,
"offset": 0,
"hasMore": false
}
}
Create Company
POST /api/companies
Creates a new company in your organization.
Request Body
{
"name": "Acme Inc",
"description": "Enterprise software company",
"website": "https://acme.com",
"industry": "Technology",
"address": "456 Market St, San Francisco, CA 94102",
"customFields": {
"cf_tier": "Enterprise"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Company name (1-200 characters) |
description |
string | No | Company description |
website |
string | No | Company website URL |
industry |
string | No | Industry sector |
address |
string | No | Full address |
customFields |
object | No | Custom field key-value pairs |
Response
Success Response (201)
{
"success": true,
"data": {
"id": "company-uuid",
"name": "Acme Inc",
"description": "Enterprise software company",
"website": "https://acme.com",
"industry": "Technology",
"address": "456 Market St, San Francisco, CA 94102",
"customFields": {
"cf_tier": "Enterprise"
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
},
"message": "Company created successfully"
}
Error Response (409)
{
"success": false,
"error": "A company with this name already exists in your organization"
}
Get Company
GET /api/companies/{id}
Retrieves details for a specific company including custom fields.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | Company UUID |
Response
Success Response (200)
{
"success": true,
"data": {
"id": "company-uuid",
"name": "Acme Inc",
"description": "Enterprise software company",
"website": "https://acme.com",
"industry": "Technology",
"address": "456 Market St, San Francisco, CA 94102",
"latitude": 37.7749,
"longitude": -122.4194,
"customFields": {
"cf_tier": "Enterprise",
"cf_account_manager": "Jane Smith"
},
"createdAt": "2024-01-15T10:00:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
}
Update Company
PATCH /api/companies/{id}
Updates an existing company. Only provided fields are updated. Custom fields are merged with existing values.
Request Body
{
"industry": "SaaS",
"customFields": {
"cf_tier": "Premium"
}
}
Response
Success Response (200)
{
"success": true,
"data": {
"id": "company-uuid",
"name": "Acme Inc",
"industry": "SaaS",
"customFields": {
"cf_tier": "Premium",
"cf_account_manager": "Jane Smith"
}
},
"message": "Company updated successfully"
}
Example Usage
# List companies with search
curl -X GET "https://beta-api.introzy.com/api/companies?search=acme&limit=10" \
-H "Authorization: Bearer introzy_your_api_key"
# Create a new company
curl -X POST "https://beta-api.introzy.com/api/companies" \
-H "Authorization: Bearer introzy_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Inc",
"website": "https://acme.com",
"industry": "Technology",
"customFields": {
"cf_tier": "Enterprise"
}
}'
# Update a company
curl -X PATCH "https://beta-api.introzy.com/api/companies/company-uuid" \
-H "Authorization: Bearer introzy_your_api_key" \
-H "Content-Type: application/json" \
-d '{"industry": "SaaS"}'
Related Endpoints
- Notes — Manage notes on companies via
GET/POST /api/companies/{companyId}/notes - Custom Fields — Define custom field schemas via
GET/POST /api/companies/custom-fields