CRM records
Look up a record in your CRM.
Look up a CRM record
GET
/v1/crm-connections/{connectionId}/recordscrm-records.lookupNeeds the ingestion feature on your workspace. Until it is on, calls answer 404.
By email, domain, or externalId with objectType. What Ken holds for the record and the Ken record it is linked to. No CRM call.
Parameters
Name
In
Type
Required
Description
connectionId
In: path
integer (int64)
required
Email
In: query
string
optional
Domain
In: query
string
optional
ExternalId
In: query
string
optional
The CRM's own record id.
ObjectType
In: query
string
optional
company, contact, deal, owner, activity or list. Required with externalId.
Ken-Version
In: header
string, one of: 2026-11-02, 1.1
required
The API version: a dated version (YYYY-MM-DD), or 1.1, another name for the first dated version. Without it the request uses your API key's pinned version; an unpinned key reaches the legacy shape of the same path. 1.0 selects the legacy shape explicitly.
X-Ken-Workspace-Id
In: header
integer (int64)
optional
Workspace to act in. Required when your credential can reach more than one workspace (otherwise
400 workspace_required).Response 200
data is a list of CrmRecordModel. Each item has these fields. The response also carries pagination.
Field
Type
Description
id
integer (int64)
objectType
string
externalId
string
externalSubtype
string
externalUrl
string
email
string
domain
string
displayName
string
ownerExternalId
string
lifecycle
string
isOptedOut
boolean
isCustomer
boolean
hasOpenDeal
boolean
lastRepActivityAt
string (date-time)
crmUpdatedAt
string (date-time)
lastSyncedAt
string (date-time)
crmDeletedAt
string (date-time)
mergedIntoExternalId
string
snapshot
map of string
linked
CrmLinkedEntityModel
Request
curl -X GET "https://api.ken.so/v1/crm-connections/812/records" \ -H "Authorization: Bearer $KEN_API_KEY" \ -H "Ken-Version: 2026-11-02" \ -H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID"
Response 200
{
"success": true,
"data": [
{
"id": 812,
"objectType": "string",
"externalId": "string",
"externalSubtype": "string",
"externalUrl": "https://example.com",
"email": "[email protected]",
"domain": "example.com",
"displayName": "string",
"ownerExternalId": "string",
"lifecycle": "string",
"isOptedOut": true,
"isCustomer": true,
"hasOpenDeal": true,
"lastRepActivityAt": "2026-09-23T15:02:11Z",
"crmUpdatedAt": "2026-09-23T15:02:11Z",
"lastSyncedAt": "2026-09-23T15:02:11Z",
"crmDeletedAt": "2026-09-23T15:02:11Z",
"mergedIntoExternalId": "string",
"snapshot": {
"key": "string"
},
"linked": {
"entityType": "string",
"entityId": 812,
"entityKey": "string",
"entityRef": "string"
}
}
],
"pagination": {
"nextCursor": "eyJpZCI6ODE1fQ",
"hasMore": true,
"total": 1,
"isTotalCapped": true
}
}