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>

POSThttps://hermeticor.com/v1/imports/url

One-off import of a CSV at an https URL: events, object records or relationships (poll GET /v1/jobs)

Request body

application/json

kindstringrequired

events | objects | relationships

urlstringrequired

objectTypestring

{
  "kind": "events",
  "url": "string",
  "objectType": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/imports/url" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"events","url":"string","objectType":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "kind": "bulk",
  "op": "string",
  "status": "queued",
  "progress": {
    "total": 0,
    "processed": 0,
    "failed": 0
  },
  "error": "string",
  "downloadUrl": "string",
  "failures": [
    {
      "profileId": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

bulk | export

opstringrequired

statusstringrequired

queued | running | completed | failed

progressobjectrequired

Show child parameters

totalintegerrequired

processedintegerrequired

failedintegerrequired

errorstringrequired

downloadUrlstring

failuresFailuresItem[]

Show child parameters

profileIdstringrequired

messagestringrequired

createdAtstringrequired

finishedAtstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/imports/url

GEThttps://hermeticor.com/v1/shared-object-schemas

Object schemas shared across the workspaces of this organization

Parameters

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/shared-object-schemas" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "fields": {},
      "removedFields": [
        "string"
      ],
      "version": 0,
      "sourceWorkspaceId": "string",
      "installed": true,
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem228[]required

Show child parameters

idstringrequired

keystringrequired

namestringrequired

fieldsobjectrequired

removedFieldsstring[]required

versionintegerrequired

sourceWorkspaceIdstringrequired

installedbooleanrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

POSThttps://hermeticor.com/v1/object-types/{id}/share

Publish this workspace's object type to the organization (re-publishing bumps the version)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "key": "string",
  "name": "string",
  "fields": {},
  "removedFields": [
    "string"
  ],
  "version": 0,
  "sourceWorkspaceId": "string",
  "installed": true,
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

keystringrequired

namestringrequired

fieldsobjectrequired

removedFieldsstring[]required

versionintegerrequired

sourceWorkspaceIdstringrequired

installedbooleanrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

POSThttps://hermeticor.com/v1/shared-object-schemas/{id}/install

Create or update the object type here from a shared schema (fields are merged, none removed)

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/shared-object-schemas/{id}/install" \
  -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 · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

DELETEhttps://hermeticor.com/v1/shared-object-schemas/{id}

Stop sharing (only from the workspace that published it; installed copies stay)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/shared-object-schemas/{id}/install

4XX Default Response

Same as 4XX · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

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

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "filename": "string",
      "url": "string",
      "contentType": "string",
      "bytes": 0,
      "uploadedBy": "string",
      "uploadedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem229[]required

Show child parameters

idstringrequired

filenamestringrequired

urlstringrequired

contentTypestringrequired

bytesintegerrequired

uploadedBystringrequired

uploadedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

POSThttps://hermeticor.com/v1/profiles/{id}/files

Attach a file (multipart field "file"; the asset library's types and limits apply)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "filename": "string",
  "url": "string",
  "contentType": "string",
  "bytes": 0,
  "uploadedBy": "string",
  "uploadedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

filenamestringrequired

urlstringrequired

contentTypestringrequired

bytesintegerrequired

uploadedBystringrequired

uploadedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

DELETEhttps://hermeticor.com/v1/profiles/{id}/files/{fileId}

Parameters

idstringpathrequired

fileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/shared-object-schemas/{id}/install

4XX Default Response

Same as 4XX · POST /v1/imports/url

5XX Default Response

Same as 4XX · POST /v1/imports/url

Updated Nov 8, 2026

Was this page helpful?