Companies
The organizations your contacts work for.
List companies
GET/api/v1/companies/
Parameters
cursorquery, string- Opaque pagination cursor (follow next/previous URLs).
searchquery, string
Response fields 39
created_sourceenumcreated_source_labelstringidstring (uuid)organisationstring (uuid)namestringcontacts_countobjectindustrystringsizeenumphone_country_codestringphonestringemailstring (email)websitestringlinkedin_urlstringcompany_typestringowner_uuidobjectowner_nameobjectstreetstringcitystringstatestringpostal_codestringcountrystringgstinstringpanstringannual_revenuestringannual_revenue_currencystringemployee_countintegerdescriptionstringfounded_yearintegerparent_companyobjecttagsobjectlast_activity_atstring (date-time)created_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectcreated_atstring (date-time)updated_atstring (date-time)custom_fieldsobject
curl "https://api.vivrecrm.com/api/v1/companies/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"created_source": "api_key",
"created_source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"contacts_count": null,
"industry": "",
"size": "1-10",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]",
"website": "https://kaverifoods.in",
"linkedin_url": "",
"company_type": "",
"owner_uuid": null,
"owner_name": null,
"street": "",
"city": "Hyderabad",
"state": "",
"postal_code": "",
"country": "India",
"gstin": "",
"pan": "",
"annual_revenue": "",
"annual_revenue_currency": "",
"employee_count": 1,
"description": "Annual plan for the Hyderabad team.",
"founded_year": 1,
"parent_company": null,
"tags": null,
"last_activity_at": "2026-10-17T09:30:00+05:30",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"created_at": "2026-10-17T09:30:00+05:30",
"updated_at": "2026-10-17T09:30:00+05:30",
"custom_fields": {}
}
]
}Create company
POST/api/v1/companies/
Body
namestringRequiredindustrystring, can be nullsizeenum, can be null- One of
1-10,11-50,51-200,201-500,501-1000,1000+. phone_country_codestringphonestring, can be nullemailstring (email), can be nullwebsitestring, can be nulllinkedin_urlstring, can be nullcompany_typestring, can be nullowner_idstring, can be nullstreetstring, can be nullcitystring, can be nullstatestring, can be nullpostal_codestring, can be nullcountrystring, can be nullgstinstring, can be nullpanstring, can be nullannual_revenuestring, can be nullannual_revenue_currencystringemployee_countinteger, can be nulldescriptionstring, can be nullfounded_yearinteger, can be nullparent_company_idstring, can be nullcustom_fieldsobject
Response fields 39
created_sourceenumcreated_source_labelstringidstring (uuid)organisationstring (uuid)namestringcontacts_countobjectindustrystringsizeenumphone_country_codestringphonestringemailstring (email)websitestringlinkedin_urlstringcompany_typestringowner_uuidobjectowner_nameobjectstreetstringcitystringstatestringpostal_codestringcountrystringgstinstringpanstringannual_revenuestringannual_revenue_currencystringemployee_countintegerdescriptionstringfounded_yearintegerparent_companyobjecttagsobjectlast_activity_atstring (date-time)created_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectcreated_atstring (date-time)updated_atstring (date-time)custom_fieldsobject
curl -X POST "https://api.vivrecrm.com/api/v1/companies/" \
-H "X-Api-Key: $VIVRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Kaveri Foods", "phone_country_code": "+91", "phone": "9876543210", "email": "[email protected]"}'import os, requests
resp = requests.post(
"https://api.vivrecrm.com/api/v1/companies/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
json={
"name": "Kaveri Foods",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]"
},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/", {
method: "POST",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Kaveri Foods",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]"
}),
});
console.log(await resp.json());{
"created_source": "api_key",
"created_source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"contacts_count": null,
"industry": "",
"size": "1-10",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]",
"website": "https://kaverifoods.in",
"linkedin_url": "",
"company_type": "",
"owner_uuid": null,
"owner_name": null,
"street": "",
"city": "Hyderabad",
"state": "",
"postal_code": "",
"country": "India",
"gstin": "",
"pan": "",
"annual_revenue": "",
"annual_revenue_currency": "",
"employee_count": 1,
"description": "Annual plan for the Hyderabad team.",
"founded_year": 1,
"parent_company": null,
"tags": null,
"last_activity_at": "2026-10-17T09:30:00+05:30",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"created_at": "2026-10-17T09:30:00+05:30",
"updated_at": "2026-10-17T09:30:00+05:30",
"custom_fields": {}
}Retrieve a company
GET/api/v1/companies/{public_id}/
Parameters
public_idpath, stringRequired- The record's public id (a UUID).
Response fields 39
created_sourceenumcreated_source_labelstringidstring (uuid)organisationstring (uuid)namestringcontacts_countobjectindustrystringsizeenumphone_country_codestringphonestringemailstring (email)websitestringlinkedin_urlstringcompany_typestringowner_uuidobjectowner_nameobjectstreetstringcitystringstatestringpostal_codestringcountrystringgstinstringpanstringannual_revenuestringannual_revenue_currencystringemployee_countintegerdescriptionstringfounded_yearintegerparent_companyobjecttagsobjectlast_activity_atstring (date-time)created_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectcreated_atstring (date-time)updated_atstring (date-time)custom_fieldsobject
curl "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"created_source": "api_key",
"created_source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"contacts_count": null,
"industry": "",
"size": "1-10",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]",
"website": "https://kaverifoods.in",
"linkedin_url": "",
"company_type": "",
"owner_uuid": null,
"owner_name": null,
"street": "",
"city": "Hyderabad",
"state": "",
"postal_code": "",
"country": "India",
"gstin": "",
"pan": "",
"annual_revenue": "",
"annual_revenue_currency": "",
"employee_count": 1,
"description": "Annual plan for the Hyderabad team.",
"founded_year": 1,
"parent_company": null,
"tags": null,
"last_activity_at": "2026-10-17T09:30:00+05:30",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"created_at": "2026-10-17T09:30:00+05:30",
"updated_at": "2026-10-17T09:30:00+05:30",
"custom_fields": {}
}Replace a company
PUT/api/v1/companies/{public_id}/
Parameters
public_idpath, stringRequired- The record's public id (a UUID).
Body
namestringRequiredindustrystring, can be nullsizeenum, can be null- One of
1-10,11-50,51-200,201-500,501-1000,1000+. phone_country_codestringphonestring, can be nullemailstring (email), can be nullwebsitestring, can be nulllinkedin_urlstring, can be nullcompany_typestring, can be nullowner_idstring, can be nullstreetstring, can be nullcitystring, can be nullstatestring, can be nullpostal_codestring, can be nullcountrystring, can be nullgstinstring, can be nullpanstring, can be nullannual_revenuestring, can be nullannual_revenue_currencystringemployee_countinteger, can be nulldescriptionstring, can be nullfounded_yearinteger, can be nullparent_company_idstring, can be nullcustom_fieldsobject
Response fields 39
created_sourceenumcreated_source_labelstringidstring (uuid)organisationstring (uuid)namestringcontacts_countobjectindustrystringsizeenumphone_country_codestringphonestringemailstring (email)websitestringlinkedin_urlstringcompany_typestringowner_uuidobjectowner_nameobjectstreetstringcitystringstatestringpostal_codestringcountrystringgstinstringpanstringannual_revenuestringannual_revenue_currencystringemployee_countintegerdescriptionstringfounded_yearintegerparent_companyobjecttagsobjectlast_activity_atstring (date-time)created_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectcreated_atstring (date-time)updated_atstring (date-time)custom_fieldsobject
curl -X PUT "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
-H "X-Api-Key: $VIVRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Kaveri Foods", "phone_country_code": "+91", "phone": "9876543210", "email": "[email protected]"}'import os, requests
resp = requests.put(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
json={
"name": "Kaveri Foods",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]"
},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
method: "PUT",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Kaveri Foods",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]"
}),
});
console.log(await resp.json());{
"created_source": "api_key",
"created_source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"contacts_count": null,
"industry": "",
"size": "1-10",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]",
"website": "https://kaverifoods.in",
"linkedin_url": "",
"company_type": "",
"owner_uuid": null,
"owner_name": null,
"street": "",
"city": "Hyderabad",
"state": "",
"postal_code": "",
"country": "India",
"gstin": "",
"pan": "",
"annual_revenue": "",
"annual_revenue_currency": "",
"employee_count": 1,
"description": "Annual plan for the Hyderabad team.",
"founded_year": 1,
"parent_company": null,
"tags": null,
"last_activity_at": "2026-10-17T09:30:00+05:30",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"created_at": "2026-10-17T09:30:00+05:30",
"updated_at": "2026-10-17T09:30:00+05:30",
"custom_fields": {}
}Update a company
PATCH/api/v1/companies/{public_id}/
Parameters
public_idpath, stringRequired- The record's public id (a UUID).
Body
namestringRequiredindustrystring, can be nullsizeenum, can be null- One of
1-10,11-50,51-200,201-500,501-1000,1000+. phone_country_codestringphonestring, can be nullemailstring (email), can be nullwebsitestring, can be nulllinkedin_urlstring, can be nullcompany_typestring, can be nullowner_idstring, can be nullstreetstring, can be nullcitystring, can be nullstatestring, can be nullpostal_codestring, can be nullcountrystring, can be nullgstinstring, can be nullpanstring, can be nullannual_revenuestring, can be nullannual_revenue_currencystringemployee_countinteger, can be nulldescriptionstring, can be nullfounded_yearinteger, can be nullparent_company_idstring, can be nullcustom_fieldsobject
Response fields 39
created_sourceenumcreated_source_labelstringidstring (uuid)organisationstring (uuid)namestringcontacts_countobjectindustrystringsizeenumphone_country_codestringphonestringemailstring (email)websitestringlinkedin_urlstringcompany_typestringowner_uuidobjectowner_nameobjectstreetstringcitystringstatestringpostal_codestringcountrystringgstinstringpanstringannual_revenuestringannual_revenue_currencystringemployee_countintegerdescriptionstringfounded_yearintegerparent_companyobjecttagsobjectlast_activity_atstring (date-time)created_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectcreated_atstring (date-time)updated_atstring (date-time)custom_fieldsobject
curl -X PATCH "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
-H "X-Api-Key: $VIVRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Kaveri Foods", "phone_country_code": "+91", "phone": "9876543210", "email": "[email protected]"}'import os, requests
resp = requests.patch(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
json={
"name": "Kaveri Foods",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]"
},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
method: "PATCH",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Kaveri Foods",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]"
}),
});
console.log(await resp.json());{
"created_source": "api_key",
"created_source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"contacts_count": null,
"industry": "",
"size": "1-10",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]",
"website": "https://kaverifoods.in",
"linkedin_url": "",
"company_type": "",
"owner_uuid": null,
"owner_name": null,
"street": "",
"city": "Hyderabad",
"state": "",
"postal_code": "",
"country": "India",
"gstin": "",
"pan": "",
"annual_revenue": "",
"annual_revenue_currency": "",
"employee_count": 1,
"description": "Annual plan for the Hyderabad team.",
"founded_year": 1,
"parent_company": null,
"tags": null,
"last_activity_at": "2026-10-17T09:30:00+05:30",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"created_at": "2026-10-17T09:30:00+05:30",
"updated_at": "2026-10-17T09:30:00+05:30",
"custom_fields": {}
}Delete a company
DELETE/api/v1/companies/{public_id}/
Parameters
public_idpath, stringRequired- The record's public id (a UUID).
curl -X DELETE "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.delete(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.status_code)const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
method: "DELETE",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(resp.status);Bulk delete
POST/api/v1/companies/bulk-delete/
Body
idsarray of string (uuid)- Company public ids. A value that is not a UUID is reported in failed.
company_idsarray of string (uuid)- Older name for ids.
Response fields 4
deletedarray of string (uuid)- The ids that were deleted, as strings, in request order (duplicates removed).
deleted_countintegerfailedarray of object- Ids not deleted. An id that is not a UUID, is in another organization, is already deleted or is outside the caller's visibility is reported as "Not found.".
failed_countinteger
curl -X POST "https://api.vivrecrm.com/api/v1/companies/bulk-delete/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.post(
"https://api.vivrecrm.com/api/v1/companies/bulk-delete/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/bulk-delete/", {
method: "POST",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"deleted": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"deleted_count": 1,
"failed": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"reason": ""
}
],
"failed_count": 1
}Add tags to many companies
POST/api/v1/companies/bulk-tag/
Body
entity_idsarray of string (uuid)Required- Public ids of the records. All must be live records of the organization, else 400.
tag_idstring (uuid)Required- The tag's public id.
Response fields 3
created_countinteger- Assignments added (records that already had the tag are not counted).
entity_idsarray of string (uuid)- Public ids of the records acted on, leaving out leads and deals the caller cannot see.
tag_idstring (uuid)
curl -X POST "https://api.vivrecrm.com/api/v1/companies/bulk-tag/" \
-H "X-Api-Key: $VIVRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"entity_ids": ["7c9e6679-7425-40de-944b-e07fc1f90ae7"], "tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'import os, requests
resp = requests.post(
"https://api.vivrecrm.com/api/v1/companies/bulk-tag/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
json={
"entity_ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/bulk-tag/", {
method: "POST",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"entity_ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}),
});
console.log(await resp.json());{
"created_count": 1,
"entity_ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}Remove tags from many companies
POST/api/v1/companies/bulk-untag/
Body
entity_idsarray of string (uuid)Required- Public ids of the records. All must be live records of the organization, else 400.
tag_idstring (uuid)Required- The tag's public id.
Response fields 3
removed_countinteger- Tag assignments deleted.
entity_idsarray of string (uuid)- Public ids of the records acted on, leaving out leads and deals the caller cannot see.
tag_idstring (uuid)
curl -X POST "https://api.vivrecrm.com/api/v1/companies/bulk-untag/" \
-H "X-Api-Key: $VIVRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"entity_ids": ["7c9e6679-7425-40de-944b-e07fc1f90ae7"], "tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'import os, requests
resp = requests.post(
"https://api.vivrecrm.com/api/v1/companies/bulk-untag/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
json={
"entity_ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/bulk-untag/", {
method: "POST",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"entity_ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}),
});
console.log(await resp.json());{
"removed_count": 1,
"entity_ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"tag_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}Company counts for the list header
GET/api/v1/companies/stats/
Response fields 8
totalintegermineinteger- Owned by the caller.
unassignedinteger- No owner.
taggedintegerthis_monthinteger- Created since the 1st of the organization's current month.
with_websiteintegerwith_phoneintegerthin_coverageinteger- Companies with fewer than 2 live contacts.
curl "https://api.vivrecrm.com/api/v1/companies/stats/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/stats/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/stats/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"total": 1,
"mine": 1,
"unassigned": 1,
"tagged": 1,
"this_month": 1,
"with_website": 1,
"with_phone": 1,
"thin_coverage": 1
}Ids of every company the list shows
GET/api/v1/companies/ids/
"Select all N matching". Takes the list's own query (search, filter (compound JSON) and ordering), and answers the public ids in the list's order, up to 10,000, with the total. Pass them in batches to the bulk actions.
Response fields 3
countinteger- Every match, which may be more than
limit. idsarray of string (uuid)- Public ids of the first
limitmatches, in the list's order. limitinteger- The most ids answered: 10,000.
curl "https://api.vivrecrm.com/api/v1/companies/ids/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/ids/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/ids/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"count": 1,
"ids": [
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
],
"limit": 1
}A company's activity timeline
GET/api/v1/companies/{public_id}/activities/
Parameters
public_idpath, stringRequired
Response fields 19
sourceenumsource_labelstringidstring (uuid)organisationstring (uuid)entity_typeenumentity_idstringentity_public_idobjecttypeenumactor_typeenumcreated_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectis_outboundbooleanresponse_time_secondsintegercontentstringcreated_atstring (date-time)emailobject
curl "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/activities/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/activities/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/activities/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"source": "api_key",
"source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"entity_type": "Contact",
"entity_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"entity_public_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "email_sent",
"actor_type": "human",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"is_outbound": true,
"response_time_seconds": 1,
"content": "Called, wants a demo on Friday.",
"created_at": "2026-10-17T09:30:00+05:30",
"email": "[email protected]"
}
]
}A company's contacts, paginated
GET/api/v1/companies/{public_id}/contacts/
Parameters
public_idpath, stringRequired
Response fields 12
idstring (uuid)first_namestringlast_namestringfull_namestringemailstringphonestringphone_country_codestringjob_titlestringwhatsapp_numberstringwhatsapp_country_codestringcompany_namestringcompany_idstring (uuid)- The company's public id.
curl "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/contacts/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/contacts/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/contacts/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"first_name": "Asha",
"last_name": "Rao",
"full_name": "Asha Rao",
"email": "[email protected]",
"phone": "9876543210",
"phone_country_code": "+91",
"job_title": "Head of Operations",
"whatsapp_number": "9876543210",
"whatsapp_country_code": "+91",
"company_name": "",
"company_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
]
}Restore a deleted company
POST/api/v1/companies/{public_id}/restore/
Parameters
public_idpath, stringRequired
Response fields 39
created_sourceenumcreated_source_labelstringidstring (uuid)organisationstring (uuid)namestringcontacts_countobjectindustrystringsizeenumphone_country_codestringphonestringemailstring (email)websitestringlinkedin_urlstringcompany_typestringowner_uuidobjectowner_nameobjectstreetstringcitystringstatestringpostal_codestringcountrystringgstinstringpanstringannual_revenuestringannual_revenue_currencystringemployee_countintegerdescriptionstringfounded_yearintegerparent_companyobjecttagsobjectlast_activity_atstring (date-time)created_by_uuidobjectcreated_by_usernameobjectcreated_by_first_nameobjectcreated_by_last_nameobjectcreated_by_nameobjectcreated_atstring (date-time)updated_atstring (date-time)custom_fieldsobject
curl -X POST "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/restore/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.post(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/restore/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/restore/", {
method: "POST",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());{
"created_source": "api_key",
"created_source_label": "",
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"contacts_count": null,
"industry": "",
"size": "1-10",
"phone_country_code": "+91",
"phone": "9876543210",
"email": "[email protected]",
"website": "https://kaverifoods.in",
"linkedin_url": "",
"company_type": "",
"owner_uuid": null,
"owner_name": null,
"street": "",
"city": "Hyderabad",
"state": "",
"postal_code": "",
"country": "India",
"gstin": "",
"pan": "",
"annual_revenue": "",
"annual_revenue_currency": "",
"employee_count": 1,
"description": "Annual plan for the Hyderabad team.",
"founded_year": 1,
"parent_company": null,
"tags": null,
"last_activity_at": "2026-10-17T09:30:00+05:30",
"created_by_uuid": null,
"created_by_username": null,
"created_by_first_name": null,
"created_by_last_name": null,
"created_by_name": null,
"created_at": "2026-10-17T09:30:00+05:30",
"updated_at": "2026-10-17T09:30:00+05:30",
"custom_fields": {}
}curl "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.get(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/", {
method: "GET",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(await resp.json());[
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"color_hex": "",
"created_at": "2026-10-17T09:30:00+05:30"
}
]Tag a company
POST/api/v1/companies/{public_id}/tags/
Parameters
public_idpath, stringRequired
Body
tag_public_idstring (uuid)Required- A tag of the organization not already on this record (400 otherwise).
Response fields 5
idstring (uuid)organisationstring (uuid)namestringcolor_hexstringcreated_atstring (date-time)
curl -X POST "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/" \
-H "X-Api-Key: $VIVRE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"tag_public_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'import os, requests
resp = requests.post(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
json={
"tag_public_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
},
)
print(resp.json())const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/", {
method: "POST",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"tag_public_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}),
});
console.log(await resp.json());{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"organisation": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Kaveri Foods",
"color_hex": "",
"created_at": "2026-10-17T09:30:00+05:30"
}Remove a tag from a company
DELETE/api/v1/companies/{public_id}/tags/{tag_id}/
Parameters
public_idpath, stringRequiredtag_idpath, stringRequired
curl -X DELETE "https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/7c9e6679-7425-40de-944b-e07fc1f90ae7/" \
-H "X-Api-Key: $VIVRE_API_KEY"import os, requests
resp = requests.delete(
"https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/7c9e6679-7425-40de-944b-e07fc1f90ae7/",
headers={"X-Api-Key": os.environ["VIVRE_API_KEY"]},
)
print(resp.status_code)const resp = await fetch("https://api.vivrecrm.com/api/v1/companies/7c9e6679-7425-40de-944b-e07fc1f90ae7/tags/7c9e6679-7425-40de-944b-e07fc1f90ae7/", {
method: "DELETE",
headers: {
"X-Api-Key": process.env.VIVRE_API_KEY,
},
});
console.log(resp.status);