OpenapiCrm
Returns one of the caller org's contacts.
Returns one of the caller org's contacts.
GET /v1/crm/contacts/{id}
| Address | https://api.hanzo.ai/v1/crm/contacts/{id} |
| Method | GET |
| Operation | get_crm_contacts_by_id |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one of the caller org's contacts. An id belonging to another org reads as not found.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the record to act on, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | Contact | ok |
200 body — 12 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
city | body | string | — | City is where the person is based. |
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. |
createdAt | body | integer | — | CreatedAt is the unix second the contact was created. |
email | body | string | — | Email is the person's email address. |
firstName | body | string | — | FirstName is the person's given name. |
id | body | string | — | ID is the server-minted contact id ("cont_" + 128 random bits). |
jobTitle | body | string | — | JobTitle is the person's role at their company. |
lastName | body | string | — | LastName is the person's family name. |
linkedinLink | body | string | — | Linkedin is the person's LinkedIn URL. |
phone | body | string | — | Phone is the person's phone number. |
updatedAt | body | integer | — | UpdatedAt is the unix second of the last write. |
xLink | body | string | — | XLink is the person's X (Twitter) URL. |
Failure carries the platform error shape — see Errors.
Examples
hanzo crm contacts get <id>import { Configuration, CrmApi } from 'hanzoai';
const api = new CrmApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCrmContactsById({ id: 'id' });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_by_id(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CrmAPI.GetCrmContactsById(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_by_id(&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).getCrmContactsById();curl https://api.hanzo.ai/v1/crm/contacts/<id> \
-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"
}
}
}'How is this guide?