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/data-sources

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "typeId": "string",
      "status": "active",
      "recordsIngested": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsPostV1DataSourcesResponse[]required

Show child parameters

idstringrequired

namestringrequired

typeIdstringrequired

statusstringrequired

active | paused

recordsIngestedintegerrequired

createdAtstringrequired

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/data-sources

POSThttps://hermeticor.com/v1/data-sources

Request body

application/json

namestringrequired

typeKeystringrequired

{
  "name": "string",
  "typeKey": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/data-sources" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","typeKey":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "typeId": "string",
  "status": "active",
  "recordsIngested": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

typeIdstringrequired

statusstringrequired

active | paused

recordsIngestedintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

GEThttps://hermeticor.com/v1/data-sources/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/data-sources

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

DELETEhttps://hermeticor.com/v1/data-sources/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/data-sources/{id}" \
  -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 · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

PATCHhttps://hermeticor.com/v1/data-sources/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

statusstring

active | paused

{
  "name": "string",
  "status": "active"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/data-sources/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","status":"active"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/data-sources

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

GEThttps://hermeticor.com/v1/data-sources/{id}/mapping

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "mapping": {
    "id": "string",
    "dataSourceId": "string",
    "externalIdField": "string",
    "nameField": "string",
    "fields": {}
  }
}

Schema

mappingobjectrequired

Show child parameters

idstringrequired

dataSourceIdstringrequired

externalIdFieldstringrequired

nameFieldstringrequired

fieldsobjectrequired

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

PUThttps://hermeticor.com/v1/data-sources/{id}/mapping

Parameters

idstringpathrequired

Request body

application/json

externalIdFieldstringrequired

nameFieldstring

fieldsobject

= {}

{
  "externalIdField": "string",
  "nameField": "string",
  "fields": {}
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/data-sources/{id}/mapping" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalIdField":"string","nameField":"string","fields":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "dataSourceId": "string",
  "externalIdField": "string",
  "nameField": "string",
  "fields": {}
}

Schema

idstringrequired

dataSourceIdstringrequired

externalIdFieldstringrequired

nameFieldstringrequired

fieldsobjectrequired

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

GEThttps://hermeticor.com/v1/source-mappings/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/data-sources/{id}/mapping

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

POSThttps://hermeticor.com/v1/data-sources/{id}/records

Send up to 500 source records; the mapping turns them into object upserts by external id

Parameters

idstringpathrequired

Request body

application/json

recordsobject[]required

{
  "records": [
    {}
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/data-sources/{id}/records" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"records":[{}]}'

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 · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

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

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "type": "string",
      "id": "string",
      "externalId": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

typestringrequired

idstringrequired

externalIdstringrequired

namestringrequired

rolestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/data-sources

5XX Default Response

Same as 4XX · GET /v1/data-sources

Next part

Updated Nov 8, 2026

Was this page helpful?