Returns the caller org's contacts, most recently updated first.

GET /v1/crm/contacts

CRM → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/crm/contacts`
Method	`GET`
Operation	`get_crm_contacts`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the caller org's contacts, most recently updated first. A companyId narrows the page to the people at that company.

Request

2 fields.

Field	In	Type	Required	Description
`companyId`	query	string	—	CompanyID returns only the contacts at that company when set.
`limit`	query	integer	—	Limit caps the rows returned: 200 by default, 1000 at most.

Response

Status	Body	Meaning
`200`	contactList	ok

200 body — 13 fields.

Field	In	Type	Always	Description
`data`	body	Contact[]	—	Data is the page of contacts, most recently updated first.
`data[].city`	body	string	—	City is where the person is based.
`data[].companyId`	body	string	—	CompanyID links the contact to one of the org's companies; empty when the contact stands alone, and cleared when its company is deleted.
`data[].createdAt`	body	integer	—	CreatedAt is the unix second the contact was created.
`data[].email`	body	string	—	Email is the person's email address.
`data[].firstName`	body	string	—	FirstName is the person's given name.
`data[].id`	body	string	—	ID is the server-minted contact id ("cont_" + 128 random bits).
`data[].jobTitle`	body	string	—	JobTitle is the person's role at their company.
`data[].lastName`	body	string	—	LastName is the person's family name.
`data[].linkedinLink`	body	string	—	Linkedin is the person's LinkedIn URL.
`data[].phone`	body	string	—	Phone is the person's phone number.
`data[].updatedAt`	body	integer	—	UpdatedAt is the unix second of the last write.
`data[].xLink`	body	string	—	XLink is the person's X (Twitter) URL.

Failure carries the platform error shape — see Errors.

Examples

hanzo crm contacts list

import { Configuration, CrmApi } from 'hanzoai';

const api = new CrmApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCrmContacts();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CrmApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CrmApi(client).get_crm_contacts()

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.CrmAPI.GetCrmContacts(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, crm_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = crm_api::get_crm_contacts(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CrmApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new CrmApi(client).getCrmContacts();

curl https://api.hanzo.ai/v1/crm/contacts \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches crm through the crm tool, which names its 20 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_crm_applications"
         }
       }
     }'

CRM API · All Hanzo APIs · Interactive reference

Returns the caller org's contacts, most recently updated first.

Request

Response

Examples

On this page