objects

Embed

<a href="https://hermeticor.com/docs/ref-objects"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/f918c38c-6845-48c7-9417-339f3e6b0dd9/social-card.svg?v=3e7ae33eec8b" alt="objects" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/associations/{type}/{id}

Everything a profile or object record is associated with, with labels

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

typestringpathrequired

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "toType": "string",
      "toId": "string",
      "name": "string",
      "label": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

toTypestringrequired

toIdstringrequired

namestringrequired

labelstringrequired

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/associations/{type}/{id}

PUThttps://hermeticor.com/v1/associations/{fromType}/{fromId}/{toType}/{toId}

Associate two records; without a label the pair's default label is used (or "related")

Parameters

fromTypestringpathrequired

fromIdstringpathrequired

toTypestringpathrequired

toIdstringpathrequired

Request body

application/json

labelstring

{
  "label": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/associations/{fromType}/{fromId}/{toType}/{toId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

DELETEhttps://hermeticor.com/v1/associations/{fromType}/{fromId}/{toType}/{toId}

Parameters

labelstringquery

fromTypestringpathrequired

fromIdstringpathrequired

toTypestringpathrequired

toIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/associations/{fromType}/{fromId}/{toType}/{toId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/associations/{fromType}/{fromId}/{toType}/{toId}

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

POSThttps://hermeticor.com/v1/associations/batch

Up to 100 associations in one call; any failure rolls back all

Request body

application/json

itemsobject[]required

Show child parameters

fromTypestringrequired

fromIdstringrequired

toTypestringrequired

toIdstringrequired

labelstring

{
  "items": [
    {
      "fromType": "string",
      "fromId": "string",
      "toType": "string",
      "toId": "string",
      "label": "string"
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/associations/batch" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"fromType":"string","fromId":"string","toType":"string","toId":"string","label":"string"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "associated": 0
}

Schema

associatedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

GEThttps://hermeticor.com/v1/association-labels

Parameters

fromTypestringquery

toTypestringquery

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/association-labels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "fromType": "string",
      "toType": "string",
      "label": "string",
      "isDefault": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem227[]required

Show child parameters

idstringrequired

fromTypestringrequired

toTypestringrequired

labelstringrequired

isDefaultbooleanrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

POSThttps://hermeticor.com/v1/association-labels

Request body

application/json

fromTypestringrequired

toTypestringrequired

labelstringrequired

isDefaultboolean

= false

{
  "fromType": "string",
  "toType": "string",
  "label": "string",
  "isDefault": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/association-labels" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromType":"string","toType":"string","label":"string","isDefault":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "fromType": "string",
  "toType": "string",
  "label": "string",
  "isDefault": true,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

fromTypestringrequired

toTypestringrequired

labelstringrequired

isDefaultbooleanrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

DELETEhttps://hermeticor.com/v1/association-labels/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/association-labels/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/associations/{fromType}/{fromId}/{toType}/{toId}

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

PATCHhttps://hermeticor.com/v1/association-labels/{id}

Parameters

idstringpathrequired

Request body

application/json

labelstring

isDefaultboolean

{
  "label": "string",
  "isDefault": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/association-labels/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","isDefault":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/association-labels

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

POSThttps://hermeticor.com/v1/objects/relationships/import

Link people (by externalId, email or phone) to object records (by type and externalId); a bad row is reported, the rest land

Request body

application/json

rowsobject[]required

Show child parameters

objectTypestringrequired

objectExternalIdstringrequired

emailstring

phonestring

externalIdstring

labelstring

{
  "rows": [
    {
      "objectType": "string",
      "objectExternalId": "string",
      "email": "string",
      "phone": "string",
      "externalId": "string",
      "label": "string"
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/objects/relationships/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"objectType":"string","objectExternalId":"string","email":"string","phone":"string","externalId":"string","label":"string"}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "linked": 0,
  "failed": [
    {
      "index": 0,
      "reason": "string"
    }
  ]
}

Schema

linkedintegerrequired

failedRejectedItem[]required

Show child parameters

indexintegerrequired

reasonstringrequired

4XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

5XX Default Response

Same as 4XX · GET /v1/associations/{type}/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?