profiles

Embed

<a href="https://hermeticor.com/docs/ref-profiles"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/5378c6e4-7f93-4868-ad25-407466520de8/social-card.svg?v=3e7ae33eec8b" alt="profiles" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/profiles/{id}/geo-ips

Parameters

limitintegerquery

= 100

countrystringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "ip": "string",
      "country": "string",
      "events": 0,
      "people": 0,
      "lastSeenAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsItemsItem184[]required

Show child parameters

ipstringrequired

countrystringrequired

eventsnumberrequired

peoplenumberrequired

lastSeenAtstringrequired

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/profiles/{id}/geo-ips

POSThttps://hermeticor.com/v1/profiles/{id}/suppress-delete

Suppress every address of a contact, delete the contact, and block its identifiers so no import, API call or event can re-create it

Parameters

idstringpathrequired

Request body

application/json

reasonstring

{
  "reason": "string"
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "suppressed": [
    {
      "channel": "email",
      "value": "string"
    }
  ],
  "blocked": 0
}

Schema

suppressedSuppressedItem[]required

Show child parameters

channelstringrequired

email | sms | whatsapp | push | postcard

valuestringrequired

blockedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

GEThttps://hermeticor.com/v1/identifier-blocks

Identifiers of suppressed-and-deleted contacts (values are kept hashed only)

Parameters

limitintegerquery

= 50

cursorstringquery

typestringquery

email | phone | external_id

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/identifier-blocks" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "type": "string",
      "reason": "string",
      "blockedBy": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

typestringrequired

reasonstringrequired

blockedBystringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

POSThttps://hermeticor.com/v1/identifier-blocks/check

Whether an email, phone or external id is blocked

Request body

application/json

typestringrequired

email | phone | external_id

valuestringrequired

{
  "type": "email",
  "value": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/identifier-blocks/check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"email","value":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "blocked": true
}

Schema

blockedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

POSThttps://hermeticor.com/v1/identifier-blocks/unblock

Allow a blocked identifier to be added again (admin; suppressions stay)

Request body

application/json

typestringrequired

email | phone | external_id

valuestringrequired

{
  "type": "email",
  "value": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/identifier-blocks/unblock" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"email","value":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

GEThttps://hermeticor.com/v1/activity/people

Activity of everyone in the workspace; filter by type, name, person and deleted people

Parameters

limitintegerquery

= 50

cursorstringquery

typestringquery

namestringquery

profileIdstringquery

deletedstringquery

exclude | include | only = exclude

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/activity/people" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "kind": "string",
      "refType": "string",
      "refId": "string",
      "summary": "string",
      "data": {},
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem3[]required

Show child parameters

idstringrequired

profileIdstringrequired

kindstringrequired

refTypestringrequired

refIdstringrequired

summarystringrequired

datarequired

atstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

GEThttps://hermeticor.com/v1/profile-filters

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "filters": {},
      "createdBy": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem225[]required

Show child parameters

idstringrequired

namestringrequired

filtersobjectrequired

createdBystringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

POSThttps://hermeticor.com/v1/profile-filters

Request body

application/json

namestringrequired

filtersobjectrequired

{
  "name": "string",
  "filters": {}
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "filters": {},
  "createdBy": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

filtersobjectrequired

createdBystringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

PUThttps://hermeticor.com/v1/profile-filters/{id}

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

filtersobjectrequired

{
  "name": "string",
  "filters": {}
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/profile-filters

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

DELETEhttps://hermeticor.com/v1/profile-filters/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/identifier-blocks/unblock

4XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

5XX Default Response

Same as 4XX · GET /v1/profiles/{id}/geo-ips

Next part

Updated Nov 8, 2026

Was this page helpful?