crm

Embed

<a href="https://hermeticor.com/docs/ref-crm"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/33f93100-1b7a-437e-92fb-01b31f9721b3/social-card.svg?v=3e7ae33eec8b" alt="crm" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/leads/companies/{id}/crm

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/companies/{id}/crm" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "connectionId": "string",
      "connectionName": "string",
      "kind": "string",
      "externalId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem240[]required

Show child parameters

connectionIdstringrequired

connectionNamestringrequired

kindstringrequired

externalIdstringrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

POSThttps://hermeticor.com/v1/leads/companies/{id}/crm/push

Create or update the company in the CRM (found by link, domain or name) and associate its contacts already in the CRM

Parameters

idstringpathrequired

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/crm/push" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "externalId": "string",
  "created": true,
  "associated": 0
}

Schema

externalIdstringrequired

createdbooleanrequired

associatedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

POSThttps://hermeticor.com/v1/leads/companies/{id}/crm/connect

Find the company in the CRM and link it without creating anything; empty fields and the owner are filled from the CRM

Parameters

idstringpathrequired

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/crm/connect" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "found": {
    "externalId": "string",
    "name": "string",
    "domain": "string",
    "industry": "string",
    "country": "string",
    "ownerId": "string",
    "custom": {}
  },
  "ownerSet": true,
  "fieldsSet": [
    "string"
  ]
}

Schema

foundobjectrequired

Show child parameters

externalIdstringrequired

namestringrequired

domainstring

industrystring

countrystring

ownerIdstring

customobject

ownerSetbooleanrequired

fieldsSetstring[]required

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

GEThttps://hermeticor.com/v1/profiles/{id}/crm

CRM records this contact is linked to

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/profiles/{id}/crm" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/leads/companies/{id}/crm

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

POSThttps://hermeticor.com/v1/profiles/{id}/crm/push

Push this contact to the CRM now

Parameters

idstringpathrequired

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/{id}/crm/push" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "result": "pushed"
}

Schema

resultstringrequired

pushed | skipped

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

POSThttps://hermeticor.com/v1/profiles/{id}/crm/find

Find this contact in the CRM by email and link it (nothing is created)

Parameters

idstringpathrequired

Request body

application/json

connectionIdstringrequired

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/{id}/crm/find" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "externalId": "string"
}

Schema

externalIdstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

GEThttps://hermeticor.com/v1/integrations/connections/{id}/crm/sources

Lists, reports, list views, campaigns or filters that can be imported

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/integrations/connections/{id}/crm/sources" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "kind": "list",
      "size": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

kindstringrequired

list | report | list_view | campaign | filter

sizeintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

GEThttps://hermeticor.com/v1/integrations/crm-imports

Parameters

connectionIdstringquery

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/integrations/crm-imports" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "sourceId": "string",
      "name": "string",
      "kind": "string",
      "listId": "string",
      "memberCount": 0,
      "lastImportedAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "status": "queued",
      "refreshHours": 0,
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem241[]required

Show child parameters

idstringrequired

connectionIdstringrequired

sourceIdstringrequired

namestringrequired

kindstringrequired

listIdstringrequired

memberCountintegerrequired

lastImportedAtstringrequired

lastErrorstringrequired

statusstringrequired

queued | running | idle | failed

refreshHoursintegerrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

POSThttps://hermeticor.com/v1/integrations/connections/{id}/crm/imports

Import (or re-import) the members of a CRM source; no consent is granted by importing

Parameters

idstringpathrequired

Request body

application/json

sourceIdstringrequired

namestringrequired

listIdstring

refreshHoursinteger

{
  "sourceId": "string",
  "name": "string",
  "listId": "string",
  "refreshHours": 0
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/integrations/connections/{id}/crm/imports" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"string","name":"string","listId":"string","refreshHours":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "connectionId": "string",
  "sourceId": "string",
  "name": "string",
  "kind": "string",
  "listId": "string",
  "memberCount": 0,
  "lastImportedAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "status": "queued",
  "refreshHours": 0,
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

connectionIdstringrequired

sourceIdstringrequired

namestringrequired

kindstringrequired

listIdstringrequired

memberCountintegerrequired

lastImportedAtstringrequired

lastErrorstringrequired

statusstringrequired

queued | running | idle | failed

refreshHoursintegerrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}/crm

Next part

Updated Nov 8, 2026

Was this page helpful?