Company API
A Company represents an organization your team is doing business with.
Company Endpoints
| Operation | Method | Endpoint |
|---|---|---|
| Create Company | POST | https://crm.twozo.io/rest/api/v1/company |
| Get Company | GET | https://crm.twozo.io/rest/api/v1/company/{id} |
| Update Company | PUT/PATCH | https://crm.twozo.io/rest/api/v1/company/{id} |
| Delete Company | DELETE | https://crm.twozo.io/rest/api/v1/company/{id} |
| List Companies | GET | https://crm.twozo.io/rest/api/v1/company/view/list?filter=name:like(w)&sort=name:asc |
| Dropdown Values | GET | https://crm.twozo.io/rest/api/v1/field/dropdown?name={INTERNAL_NAME} |
| Field List | GET | https://crm.twozo.io/rest/api/v1/field/list?source=company |
List API (GET)
GET: https://crm.twozo.io/rest/api/v1/company/view/list?filter={internalname}:like(w)&sort={internalname}:asc
Example:
https://crm.twozo.io/rest/api/v1/company/view/list?filter=name:like(w)&sort=name:asc
Pagination Parameters
| Parameter | Description | Example |
|---|---|---|
page | Page number | page=1 |
pageSize | Number of records per page | size=25 |
Filter Parameters
Format:
filter=<field>:<operator>(<value>)
Supported Filter Operators
| Operator | Meaning | Example Request | Equivalent Condition |
|---|---|---|---|
eq | Equals | filter=status:eq(active) | status = 'active' |
neq | Not Equals | filter=status:neq(archived) | status != 'archived' |
in | In List | filter=status:in(active,pending) | status IN ('active','pending') |
nin | Not In List | filter=status:nin(deleted,archived) | status NOT IN ('deleted','archived') |
lt | Less Than | filter=amount:lt(500) | amount < 500 |
lte | Less Than or Equal | filter=amount:lte(1000) | amount <= 1000 |
gt | Greater Than | filter=amount:gt(100) | amount > 100 |
gte | Greater Than or Equal | filter=amount:gte(250) | amount >= 250 |
between | Range | filter=createdAt:between(1771936945416,1771936947532) | createdAt BETWEEN value1 AND value2 |
like | Contains Text | filter=name:like(john) | name LIKE '%john%' |
Filter Examples
&filter=status:eq(active)
&filter=status:neq(archived)
&filter=status:in(active,pending)
&filter=status:nin(deleted,archived)
&filter=amount:lt(500)
&filter=amount:lte(1000)
&filter=amount:gt(100)
&filter=amount:gte(250)
&filter=createdAt:between(1771936945416,1771936947532)
&filter=name:like(john)
&filter=deletedAt:isnull(true)
&filter=deletedAt:notnull(true)
&filter=metadata.notes:exists(true)
Sort Parameters
Format:
sort=<field>:<direction>
Multiple sort fields can be separated by commas.
Supported Sort Directions
| Direction | Meaning |
|---|---|
asc | Ascending Order |
desc | Descending Order |
Sort Examples
| Request | Description |
|---|---|
sort=createdAt:desc | Sort by created date descending |
sort=name:asc | Sort by name ascending |
sort=createdAt:desc,name:asc | Sort by created date descending, then name ascending |
Example
&sort=createdAt:desc,name:asc
FieldList
GET: https://crm.twozo.io/rest/api/v1/field/list?source=company
FieldList Response
{
"code": 0,
"data": {
"source": {
"is_enabled": true,
"name": "Company",
"id": 102
},
"fields": [
[
{
"internal_name": "name",
"is_active": true,
"source_id": 102,
"id": 144,
"type": "SINGLE_STRING",
"config": {
"min_length": 1,
"max_length": 255
},
"field_name": "Name"
}
],
[
{
"internal_name": "website",
"is_active": true,
"source_id": 102,
"id": 145,
"type": "SINGLE_STRING",
"config": {
"min_length": 1,
"max_length": 32000
},
"field_name": "Website"
}
],
[
{
"internal_name": "sales_owner",
"is_active": true,
"source_id": 102,
"id": 146,
"type": "OWNER",
"config": {},
"field_name": "Sales Owner"
}
],
[
{
"internal_name": "address",
"is_active": true,
"sub_fields": [
{
"name": "COUNTRY",
"input_type": "DROPDOWN",
"id": 16,
"type": "ADDRESS",
"display_name": "Country",
"config": {
"dropdown": "countryList"
}
},
{
"name": "LATITUDE",
"input_type": "SINGLE_NUMBER",
"id": 20,
"type": "ADDRESS",
"display_name": "Latitude",
"config": {
"isWholeNumber": false,
"isFilterable": false
}
},
{
"name": "LONGITUDE",
"input_type": "SINGLE_NUMBER",
"id": 21,
"type": "ADDRESS",
"display_name": "Longitude",
"config": {
"isWholeNumber": false,
"isFilterable": false
}
},
{
"name": "CITY",
"input_type": "SINGLE_STRING",
"id": 14,
"type": "ADDRESS",
"display_name": "City",
"config": {
"maxLength": 125,
"maxLengthMessage": "i18n.fields.violation.message.max.length"
}
},
{
"name": "STATE",
"input_type": "SINGLE_STRING",
"id": 15,
"type": "ADDRESS",
"display_name": "State",
"config": {
"maxLength": 125,
"maxLengthMessage": "i18n.fields.violation.message.max.length"
}
},
{
"name": "ZIPCODE",
"input_type": "SINGLE_STRING",
"id": 17,
"type": "ADDRESS",
"display_name": "Pincode",
"config": {
"maxLength": 25,
"maxLengthMessage": "i18n.fields.violation.message.max.length"
}
},
{
"name": "ADDRESS_LINE1",
"input_type": "TEXT",
"id": 18,
"type": "ADDRESS",
"display_name": "AddressLine1",
"config": {
"isFilterable": false,
"maxLength": 300,
"maxLengthMessage": "i18n.fields.violation.message.max.length",
"isDuplicateCheckEnabled": true
}
},
{
"name": "ADDRESS_LINE2",
"input_type": "TEXT",
"id": 19,
"type": "ADDRESS",
"display_name": "AddressLine2",
"config": {
"isFilterable": false,
"maxLength": 300,
"maxLengthMessage": "i18n.fields.violation.message.max.length",
"isDuplicateCheckEnabled": true
}
}
],
"source_id": 102,
"id": 147,
"type": "ADDRESS",
"config": {},
"field_name": "Address"
}
],
[
{
"internal_name": "facebook",
"is_active": true,
"source_id": 102,
"id": 148,
"type": "SINGLE_STRING",
"config": {
"min_length": 1,
"max_length": 32000
},
"field_name": "Facebook"
}
],
[
{
"internal_name": "twitter",
"is_active": true,
"source_id": 102,
"id": 149,
"type": "SINGLE_STRING",
"config": {
"min_length": 1,
"max_length": 32000
},
"field_name": "Twitter"
}
],
[
{
"internal_name": "linkedIn",
"is_active": true,
"source_id": 102,
"id": 150,
"type": "SINGLE_STRING",
"config": {
"min_length": 1,
"max_length": 32000
},
"field_name": "LinkedIn"
}
],
[
{
"internal_name": "annual_revenue",
"is_active": true,
"sub_fields": [
{
"name": "CURRENCY",
"input_type": "DROPDOWN",
"id": 6,
"type": "MONETARY",
"display_name": "Currency",
"config": {
"dropdown": "currencyList"
}
},
{
"name": "VALUE",
"input_type": "SINGLE_NUMBER",
"id": 7,
"type": "MONETARY",
"display_name": "Price",
"config": {
"isWholeNumber": false,
"default": 0.0
}
}
],
"source_id": 102,
"id": 151,
"type": "MONETARY",
"config": {
"min": 0,
"max": 9999999999999
},
"field_name": "Annual Revenue"
}
],
[
{
"internal_name": "sic_code",
"is_active": true,
"source_id": 102,
"id": 152,
"type": "SINGLE_NUMBER",
"config": {
"min": 0,
"max": 9999
},
"field_name": "SIC Code"
}
],
[
{
"internal_name": "territory",
"is_active": true,
"source_id": 102,
"id": 153,
"type": "TERRITORY",
"config": {},
"field_name": "Territory"
}
],
[
{
"internal_name": "tags",
"is_active": true,
"source_id": 102,
"id": 154,
"type": "TAGS",
"config": {
"max_limit": 10,
"max_length": 255
},
"field_name": "Tags"
}
],
[
{
"internal_name": "employee_count",
"is_active": true,
"source_id": 102,
"id": 155,
"type": "SINGLE_NUMBER",
"config": {
"min": 0,
"max": 9999999999999999
},
"field_name": "Employees"
}
],
[
{
"internal_name": "parent_company",
"is_active": true,
"related_field": {
"id": 144,
"source": "Company"
},
"source_id": 102,
"id": 156,
"type": "COMPANY_ONBOARD",
"config": {},
"field_name": "Parent Company"
}
],
[
{
"internal_name": "parent_company",
"is_active": true,
"options": [
{
"name": "Acquired",
"id": 9218980
},
{
"name": "Active",
"id": 9218981
},
{
"name": "Market Failed",
"id": 9218982
},
{
"name": "Project Cancelled",
"id": 9218983
},
{
"name": "Shutdown",
"id": 9218984
}
],
"source_id": 102,
"id": 157,
"type": "DROPDOWN",
"config": {},
"field_name": "Organization Status"
}
],
[
{
"internal_name": "industry_type",
"is_active": true,
"options": [
{
"name": "Accounting",
"id": 9218998
},
{
"name": "Advertising",
"id": 9218999
},
{
"name": "Aerospace",
"id": 9219000
},
{
"name": "Agriculture",
"id": 9219001
},
{
"name": "Aircraft",
"id": 9219002
},
{
"name": "Airline",
"id": 9219003
},
{
"name": "Apparel & Accessories",
"id": 9219004
},
{
"name": "Automotive",
"id": 9219005
},
{
"name": "Banking",
"id": 9219006
},
{
"name": "Biotechnology",
"id": 9219007
},
{
"name": "Broadcasting",
"id": 9219008
},
{
"name": "Brokerage",
"id": 9219009
},
{
"name": "Call Centers",
"id": 9219010
},
{
"name": "Cargo Handling",
"id": 9219011
},
{
"name": "Chemicals",
"id": 9219012
},
{
"name": "Computer",
"id": 9219013
},
{
"name": "Construction",
"id": 9219014
},
{
"name": "Consulting",
"id": 9219015
},
{
"name": "Consumer Products",
"id": 9219016
},
{
"name": "Cosmetics",
"id": 9219017
},
{
"name": "Defense",
"id": 9219018
},
{
"name": "Department Stores",
"id": 9219019
},
{
"name": "Ecommerce",
"id": 9219020
},
{
"name": "Education",
"id": 9219021
},
{
"name": "Electronics",
"id": 9219022
},
{
"name": "Energy",
"id": 9219023
},
{
"name": "Engineering",
"id": 9219024
},
{
"name": "Entertainment & Leisure",
"id": 9219025
},
{
"name": "Executive Search",
"id": 9219026
},
{
"name": "Financial Services",
"id": 9219027
},
{
"name": "Food, Beverage & Tobacco",
"id": 9219028
},
{
"name": "Gaming",
"id": 9219029
},
{
"name": "Government",
"id": 9219030
},
{
"name": "Grocery",
"id": 9219031
},
{
"name": "Health Care",
"id": 9219032
},
{
"name": "Hospitality",
"id": 9219033
},
{
"name": "Insurance",
"id": 9219034
},
{
"name": "Internet Publishing",
"id": 9219035
},
{
"name": "Investment Banking",
"id": 9219036
},
{
"name": "Legal",
"id": 9219037
},
{
"name": "Machinery",
"id": 9219038
},
{
"name": "Manufacturing",
"id": 9219039
},
{
"name": "Media",
"id": 9219040
},
{
"name": "Motion Picture & Video",
"id": 9219041
},
{
"name": "Music",
"id": 9219042
},
{
"name": "Newspaper Publishers",
"id": 9219043
},
{
"name": "Not for Profit",
"id": 9219044
},
{
"name": "Online Auctions",
"id": 9219045
},
{
"name": "Other",
"id": 9219046
},
{
"name": "Pension Funds",
"id": 9219047
},
{
"name": "Pharmaceuticals",
"id": 9219048
},
{
"name": "Private Equity",
"id": 9219049
},
{
"name": "Publishing",
"id": 9219050
},
{
"name": "Real Estate",
"id": 9219051
},
{
"name": "Retail & Wholesale",
"id": 9219052
},
{
"name": "Securities & Commodity Exchanges",
"id": 9219053
},
{
"name": "Service",
"id": 9219054
},
{
"name": "Shipping",
"id": 9219055
},
{
"name": "Soap & Detergent",
"id": 9219056
},
{
"name": "Software",
"id": 9219057
},
{
"name": "Sports",
"id": 9219058
},
{
"name": "Technology",
"id": 9219059
},
{
"name": "Telecommunications",
"id": 9219060
},
{
"name": "Television",
"id": 9219061
},
{
"name": "Transportation",
"id": 9219062
},
{
"name": "Trucking",
"id": 9219063
},
{
"name": "Utilities",
"id": 9219064
},
{
"name": "Venture Capital",
"id": 9219065
}
],
"source_id": 102,
"id": 158,
"type": "DROPDOWN",
"config": {},
"field_name": "Industry Type"
}
],
[
{
"internal_name": "business_type",
"is_active": true,
"options": [
{
"name": "Analyst",
"id": 9218985
},
{
"name": "Competitor",
"id": 9218986
},
{
"name": "Customer",
"id": 9218987
},
{
"name": "Distributor",
"id": 9218988
},
{
"name": "Integrator",
"id": 9218989
},
{
"name": "Investor",
"id": 9218990
},
{
"name": "Other",
"id": 9218991
},
{
"name": "Partner",
"id": 9218992
},
{
"name": "Press",
"id": 9218993
},
{
"name": "Prospect",
"id": 9218994
},
{
"name": "Reseller",
"id": 9218995
},
{
"name": "Supplier",
"id": 9218996
},
{
"name": "Vendor",
"id": 9218997
}
],
"source_id": 102,
"id": 159,
"type": "DROPDOWN",
"config": {},
"field_name": "Business Type"
}
],
[
{
"internal_name": "description",
"is_active": true,
"source_id": 102,
"id": 160,
"type": "SINGLE_STRING",
"config": {
"min_length": 1,
"max_length": 255
},
"field_name": "Description"
}
],
[
{
"internal_name": "created_by",
"is_active": true,
"source_id": 102,
"id": 161,
"type": "OWNER",
"config": {},
"field_name": "Created By"
}
],
[
{
"internal_name": "created_at",
"is_active": true,
"source_id": 102,
"id": 162,
"type": "DATE_TIME",
"config": {},
"field_name": "Created At"
}
],
[
{
"internal_name": "updated_by",
"is_active": true,
"source_id": 102,
"id": 163,
"type": "OWNER",
"config": {},
"field_name": "Updated By"
}
],
[
{
"internal_name": "updated_at",
"is_active": true,
"source_id": 102,
"id": 164,
"type": "DATE_TIME",
"config": {},
"field_name": "Updated At"
}
],
[
{
"internal_name": "last_assigned_at",
"is_active": true,
"source_id": 102,
"id": 165,
"type": "DATE_TIME",
"config": {},
"field_name": "Last Assigned At"
}
],
[
{
"internal_name": "id",
"is_active": true,
"source_id": 102,
"id": 166,
"type": "SINGLE_NUMBER",
"config": {},
"field_name": "ID"
}
],
[
{
"internal_name": "recent_note",
"is_active": true,
"source_id": 102,
"id": 180,
"type": "TEXT",
"config": {},
"field_name": "Recent Note"
}
],
[
{
"internal_name": "open_deals",
"is_active": true,
"source_id": 102,
"id": 167,
"type": "DEAL",
"config": {},
"field_name": "Open Deals"
}
],
[
{
"internal_name": "closed_deals",
"is_active": true,
"source_id": 102,
"id": 168,
"type": "DEAL",
"config": {},
"field_name": "Closed Deals"
}
],
[
{
"internal_name": "won_deals",
"is_active": true,
"source_id": 102,
"id": 169,
"type": "DEAL",
"config": {},
"field_name": "Won Deals"
}
],
[
{
"internal_name": "lost_deals",
"is_active": true,
"source_id": 102,
"id": 170,
"type": "DEAL",
"config": {},
"field_name": "Lost Deals"
}
],
[
{
"internal_name": "last_activity_date",
"is_active": true,
"source_id": 102,
"id": 171,
"type": "DATE",
"config": {},
"field_name": "Last Activity Date"
}
],
[
{
"internal_name": "next_activity_date",
"is_active": true,
"source_id": 102,
"id": 172,
"type": "DATE",
"config": {},
"field_name": "Next Activity Date"
}
],
[
{
"internal_name": "last_activity_type",
"is_active": true,
"source_id": 102,
"id": 173,
"type": "SINGLE_STRING",
"config": {},
"field_name": "Last Activity Type"
}
],
[
{
"internal_name": "done_activities",
"is_active": true,
"source_id": 102,
"id": 174,
"type": "SINGLE_NUMBER",
"config": {},
"field_name": "Done Activities"
}
],
[
{
"internal_name": "upcoming_activities",
"is_active": true,
"source_id": 102,
"id": 175,
"type": "SINGLE_NUMBER",
"config": {},
"field_name": "Upcoming Activities"
}
],
[
{
"internal_name": "total_activities",
"is_active": true,
"source_id": 102,
"id": 176,
"type": "SINGLE_NUMBER",
"config": {},
"field_name": "Total Activities"
}
],
[
{
"internal_name": "email_message_count",
"is_active": true,
"source_id": 102,
"id": 177,
"type": "SINGLE_NUMBER",
"config": {},
"field_name": "Email Messages Count"
}
],
[
{
"internal_name": "last_email_received",
"is_active": true,
"source_id": 102,
"id": 178,
"type": "DATE_TIME",
"config": {},
"field_name": "Last Email Received"
}
],
[
{
"internal_name": "last_email_sent",
"is_active": true,
"source_id": 102,
"id": 179,
"type": "DATE_TIME",
"config": {},
"field_name": "Last Email Sent"
}
],
[
{
"internal_name": "cf_custom_text_field",
"is_active": true,
"source_id": 102,
"id": 124619,
"type": "SINGLE_STRING",
"config": {
"max_length": 255
},
"field_name": "custom_text_field"
}
],
[
{
"internal_name": "cf_custom_large_text_field",
"is_active": true,
"source_id": 102,
"id": 124620,
"type": "TEXT",
"config": {
"max_length": 32000
},
"field_name": "custom_large_text_field"
}
],
[
{
"internal_name": "cf_custom_number_field",
"is_active": true,
"source_id": 102,
"id": 124621,
"type": "SINGLE_NUMBER",
"config": {
"min": 0,
"max": 9999999999999999
},
"field_name": "custom_number_field"
}
],
[
{
"internal_name": "cf_custom_dropdown_field",
"is_active": true,
"options": [
{
"name": "aaa",
"id": 10416878
},
{
"name": "bbb",
"id": 10416879
}
],
"source_id": 102,
"id": 124622,
"type": "DROPDOWN",
"config": {},
"field_name": "custom_dropdown_field"
}
],
[
{
"internal_name": "cf_custom_multiselect_field",
"is_active": true,
"options": [
{
"name": "aaaa",
"id": 10416880
},
{
"name": "bbbbb",
"id": 10416881
},
{
"name": "ccccc",
"id": 10416882
}
],
"source_id": 102,
"id": 124623,
"type": "MULTI_SELECT",
"config": {},
"field_name": "custom_multiselect_field"
}
],
[
{
"internal_name": "cf_custom_owner_field",
"is_active": true,
"source_id": 102,
"id": 124624,
"type": "OWNER",
"config": {},
"field_name": "custom_owner_field"
}
],
[
{
"internal_name": "cf_custom_company_field",
"is_active": true,
"source_id": 102,
"id": 124625,
"type": "COMPANY",
"config": {},
"field_name": "custom_company_field"
}
],
[
{
"internal_name": "cf_custom_contact_field",
"is_active": true,
"source_id": 102,
"id": 124626,
"type": "CONTACT",
"config": {},
"field_name": "custom_contact_field"
}
],
[
{
"internal_name": "cf_custom_phone_field",
"is_active": true,
"sub_fields": [
{
"name": "PHONE_TYPE",
"input_type": "DROPDOWN",
"id": 1,
"type": "PHONE",
"display_name": "Phone Type",
"config": {
"dropdown": "phoneType"
}
},
{
"name": "COUNTRY_CODE",
"input_type": "DROPDOWN",
"id": 2,
"type": "PHONE",
"display_name": "Country Code",
"config": {
"dropdown": "countryList"
}
},
{
"name": "PHONE_NUMBER",
"input_type": "SINGLE_NUMBER",
"id": 3,
"type": "PHONE",
"display_name": "Phone Number"
}
],
"source_id": 102,
"id": 124627,
"type": "PHONE",
"config": {},
"field_name": "custom_phone_field"
}
],
[
{
"internal_name": "cf_custom_email_field",
"is_active": true,
"sub_fields": [
{
"name": "EMAIL_TYPE",
"input_type": "DROPDOWN",
"id": 4,
"type": "EMAIL",
"display_name": "Email Type",
"config": {
"dropdown": "emailType"
}
},
{
"name": "EMAIL_VALUE",
"input_type": "SINGLE_STRING",
"id": 5,
"type": "EMAIL",
"display_name": "Email"
}
],
"source_id": 102,
"id": 124628,
"type": "EMAIL",
"config": {
"max_length": 320
},
"field_name": "custom_email_field"
}
],
[
{
"internal_name": "cf_custom_monetary_field",
"is_active": true,
"sub_fields": [
{
"name": "CURRENCY",
"input_type": "DROPDOWN",
"id": 6,
"type": "MONETARY",
"display_name": "Currency",
"config": {
"dropdown": "currencyList"
}
},
{
"name": "VALUE",
"input_type": "SINGLE_NUMBER",
"id": 7,
"type": "MONETARY",
"display_name": "Price",
"config": {
"isWholeNumber": false,
"default": 0.0
}
}
],
"source_id": 102,
"id": 124629,
"type": "MONETARY",
"config": {
"min": 0,
"max": 9999999999999
},
"field_name": "custom_monetary_field"
}
],
[
{
"internal_name": "cf_custom_address_field",
"is_active": true,
"sub_fields": [
{
"name": "COUNTRY",
"input_type": "DROPDOWN",
"id": 16,
"type": "ADDRESS",
"display_name": "Country",
"config": {
"dropdown": "countryList"
}
},
{
"name": "LATITUDE",
"input_type": "SINGLE_NUMBER",
"id": 20,
"type": "ADDRESS",
"display_name": "Latitude",
"config": {
"isWholeNumber": false,
"isFilterable": false
}
},
{
"name": "LONGITUDE",
"input_type": "SINGLE_NUMBER",
"id": 21,
"type": "ADDRESS",
"display_name": "Longitude",
"config": {
"isWholeNumber": false,
"isFilterable": false
}
},
{
"name": "CITY",
"input_type": "SINGLE_STRING",
"id": 14,
"type": "ADDRESS",
"display_name": "City",
"config": {
"maxLength": 125,
"maxLengthMessage": "i18n.fields.violation.message.max.length"
}
},
{
"name": "STATE",
"input_type": "SINGLE_STRING",
"id": 15,
"type": "ADDRESS",
"display_name": "State",
"config": {
"maxLength": 125,
"maxLengthMessage": "i18n.fields.violation.message.max.length"
}
},
{
"name": "ZIPCODE",
"input_type": "SINGLE_STRING",
"id": 17,
"type": "ADDRESS",
"display_name": "Pincode",
"config": {
"maxLength": 25,
"maxLengthMessage": "i18n.fields.violation.message.max.length"
}
},
{
"name": "ADDRESS_LINE1",
"input_type": "TEXT",
"id": 18,
"type": "ADDRESS",
"display_name": "AddressLine1",
"config": {
"isFilterable": false,
"maxLength": 300,
"maxLengthMessage": "i18n.fields.violation.message.max.length",
"isDuplicateCheckEnabled": true
}
},
{
"name": "ADDRESS_LINE2",
"input_type": "TEXT",
"id": 19,
"type": "ADDRESS",
"display_name": "AddressLine2",
"config": {
"isFilterable": false,
"maxLength": 300,
"maxLengthMessage": "i18n.fields.violation.message.max.length",
"isDuplicateCheckEnabled": true
}
}
],
"source_id": 102,
"id": 124630,
"type": "ADDRESS",
"config": {},
"field_name": "Custom Address Field"
}
],
[
{
"internal_name": "cf_custom_time_field",
"is_active": true,
"source_id": 102,
"id": 124716,
"type": "TIME",
"config": {},
"field_name": "custom_time_field"
}
]
]
}
}Company Fields
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Required | Name of the company. Example: "demo_company6" |
description | string | Optional | Free-text notes describing the company. Example: "demo purpose"Note: Source payload also contains a misspelled escription key. Use description only. |
industry_type | number or string | Optional | ID or name of the industry the company operates in. Example: 9219006, Banking |
address | object | Optional | Structured address of the company. |
facebook | string | Optional | URL of the company's Facebook page. Example: https://www.facebook.com |
twitter | string | Optional | URL of the company's Twitter profile. Example: https://www.twitter.com |
linkedIn | string | Optional | URL of the company's LinkedIn page. Example: https://www.linkedin.com |
parent_company | number | Optional | ID of the parent company for representing a corporate hierarchy. Example: 111085 |
organization_status | number or string | Optional | ID or name representing the company's organization status. Example: 9218981, Active |
annual_revenue | object | Optional | Annual revenue of the company. |
sic_code | number | Optional | Standard Industrial Classification (SIC) code. Example: 5357 |
territory | number | Optional | ID of the sales territory the company belongs to. Example: 63064 |
tags | array<number> | Optional | List of tag IDs used to categorize the company. Example: [65316] |
employee_count | number | Optional | Number of employees at the company. Example: 700 |
business_type | number or string | Optional | ID or name representing the company's business type. Example: 9218986, Investor |
sales_owner | number | Required | ID of the sales representative or owner assigned to the company. Example: 71591 |
Address Object
| Field | Type | Required | Description |
|---|---|---|---|
address_line1 | string | Optional | Primary street address line. Example: "123 Maple Street" |
address_line2 | string | Optional | Secondary street address line. Example: "Suite 405, Downtown District" |
city | string | Optional | City of the company's address. Example: "Austin" |
state | string | Optional | State or province. Example: "Texas" |
country | number or string | Optional | Numeric ID or name representing the country. Example: 165, United StatesSee Dropdown Option List – Overview. |
zipcode | string | Optional | Postal / ZIP code. Example: "78701" |
Annual Revenue Object
| Field | Type | Required | Description |
|---|---|---|---|
currency | number, code, or name | Required | ID, code, or name of the currency the value is denominated in. Example: 3, USD, United States DollarSee Dropdown Option List – Overview. |
value | number | Required | Annual revenue amount. Example: 1234567890123.4568 |
Dropdown Field Types
- All company dropdown field options are dynamic and should be fetched using the corresponding API.
Mandatory fields required to create a company:
- Company Name
- Sales Owner
- Any system or custom field marked as Required in Modules & Fields must be included in the request.
- Any field configured with a Default Value in Modules & Fields is automatically populated if it is not included in the request.