Hanzo
OpenapiCrm

Summary counts the caller org's CRM records: companies, contacts, opportunities.

Summary counts the caller org's CRM records: companies, contacts, opportunities.

GET /v1/crm/summary

Addresshttps://api.hanzo.ai/v1/crm/summary
MethodGET
Operationget_crm_summary
AuthAuthorization: Bearer $HANZO_API_KEY

Summary counts the caller org's CRM records: companies, contacts, opportunities.

Request

GET /v1/crm/summary takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200crmSummaryok

200 body — 3 fields.

FieldInTypeAlwaysDescription
companiesbodyintegerCompanies is how many companies the org has.
contactsbodyintegerContacts is how many contacts the org has.
opportunitiesbodyintegerOpportunities is how many opportunities the org has.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm summary

CRM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page