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>

PUThttps://hermeticor.com/v1/object-types/{id}/relationships

Parameters

idstringpathrequired

Request body

application/json

targetstringrequired

namestringrequired

cardinalitystring

one_to_one | one_to_many | many_to_many = many_to_many

{
  "target": "profile",
  "name": "string",
  "cardinality": "many_to_many"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/object-types/{id}/relationships" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target":"profile","name":"string","cardinality":"many_to_many"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "typeId": "string",
  "target": "string",
  "name": "string",
  "cardinality": "one_to_one"
}

Schema

idstringrequired

typeIdstringrequired

targetstringrequired

namestringrequired

cardinalitystringrequired

one_to_one | one_to_many | many_to_many

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

DELETEhttps://hermeticor.com/v1/object-types/{id}/relationships/{target}

Parameters

idstringpathrequired

targetstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/object-types/{id}/relationships/{target}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

GEThttps://hermeticor.com/v1/object-types/{id}/ingestion-logs

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/object-types/{id}/ingestion-logs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "op": "upsert",
      "total": 0,
      "created": 0,
      "updated": 0,
      "deleted": 0,
      "failed": 0,
      "errors": [
        {
          "index": 0,
          "externalId": "string",
          "reason": "string"
        }
      ],
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

opstringrequired

upsert | delete

totalintegerrequired

createdintegerrequired

updatedintegerrequired

deletedintegerrequired

failedintegerrequired

errorsErrorsItem4[]required

Show child parameters

indexintegerrequired

externalIdstringrequired

reasonstringrequired

atstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

POSThttps://hermeticor.com/v1/objects/{type}/bulk

Upsert up to 500 records by externalId; bad records are reported, the rest land

Parameters

typestringpathrequired

Request body

application/json

recordsobject[]required

Show child parameters

externalIdstringrequired

namestringrequired

attributesobject

= {}

{
  "records": [
    {
      "externalId": "string",
      "name": "string",
      "attributes": {}
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/objects/{type}/bulk" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"records":[{"externalId":"string","name":"string","attributes":{}}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "created": 0,
  "updated": 0,
  "deleted": 0,
  "failed": [
    {
      "index": 0,
      "externalId": "string",
      "reason": "string"
    }
  ]
}

Schema

createdintegerrequired

updatedintegerrequired

deletedintegerrequired

failedErrorsItem4[]required

Show child parameters

indexintegerrequired

externalIdstringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

POSThttps://hermeticor.com/v1/objects/{type}/bulk-delete

Parameters

typestringpathrequired

Request body

application/json

externalIdsstring[]required

{
  "externalIds": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/objects/{type}/bulk-delete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/objects/{type}/bulk

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

POSThttps://hermeticor.com/v1/objects/{type}/query

Parameters

typestringpathrequired

Request body

application/json

searchstring

filterConditionsItem[]

= []

Show child parameters

propertystringrequired

opstring

eq | neq | gt | gte | lt | lte | contains | not_contains | starts_with | ends_with | exists | not_exists | in | not_in | between = eq

valuestring | number | boolean | string | number[]

limitinteger

= 50

cursorstring

{
  "search": "string",
  "filter": [],
  "limit": 50,
  "cursor": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/objects/{type}/query" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"search":"string","filter":[],"limit":50,"cursor":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "typeId": "string",
      "externalId": "string",
      "name": "string",
      "attributes": {},
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem72[]required

Show child parameters

idstringrequired

typeIdstringrequired

externalIdstringrequired

namestringrequired

attributesobjectrequired

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

GEThttps://hermeticor.com/v1/objects/{type}/{id}/relations

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/objects/{type}/{id}/relations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "direction": "out",
      "kind": "string",
      "type": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

directionstringrequired

out | in

kindstringrequired

typestringrequired

idstringrequired

namestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

POSThttps://hermeticor.com/v1/objects/{type}/{id}/relations

Parameters

typestringpathrequired

idstringpathrequired

Request body

application/json

toTypestringrequired

toIdstringrequired

kindstring

= related

{
  "toType": "string",
  "toId": "string",
  "kind": "related"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/objects/{type}/{id}/relations" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"toType":"string","toId":"string","kind":"related"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/object-types/{id}/relationships/{target}

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

DELETEhttps://hermeticor.com/v1/objects/{type}/{id}/relations/{toId}/{kind}

Parameters

typestringpathrequired

idstringpathrequired

toIdstringpathrequired

kindstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/objects/{type}/{id}/relations/{toId}/{kind}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/object-types/{id}/relationships/{target}

4XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

5XX Default Response

Same as 4XX · PUT /v1/object-types/{id}/relationships

Next part

Updated Nov 8, 2026

Was this page helpful?