segments

Embed

<a href="https://hermeticor.com/docs/ref-segments"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a1bf95e7-ade8-4fcf-b9dd-0119dc7aeef8/social-card.svg?v=3e7ae33eec8b" alt="segments" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/segments/{id}/diff

Who joined and who left between two dates, from membership history

Parameters

fromstringqueryrequired

tostringqueryrequired

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/segments/{id}/diff?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "segmentId": "string",
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "joined": {
    "count": 0,
    "sample": [
      {
        "profileId": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "at": "2024-01-01T00:00:00Z"
      }
    ]
  },
  "left": {
    "count": 0,
    "sample": [
      {
        "profileId": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "at": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

Schema

segmentIdstringrequired

fromstringrequired

tostringrequired

joinedobjectrequired

Show child parameters

countintegerrequired

sampleSampleItem[]required

Show child parameters

profileIdstringrequired

emailstringrequired

firstNamestringrequired

lastNamestringrequired

atstringrequired

leftobjectrequired

Show child parameters

countintegerrequired

sampleSampleItem[]required

Show child parameters

profileIdstringrequired

emailstringrequired

firstNamestringrequired

lastNamestringrequired

atstringrequired

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/segments/{id}/diff

GEThttps://hermeticor.com/v1/attributes

Attribute catalogue for the segment builder: standard fields, observed custom attribute keys + inferred types, event names with property keys (sampled, cached 5 min)

Parameters

refreshstringquery

true | false

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "standard": [
    {
      "key": "string",
      "type": "string"
    }
  ],
  "custom": [
    {
      "key": "string",
      "type": "string",
      "mixed": true,
      "count": 0
    }
  ],
  "events": [
    {
      "name": "string",
      "category": "standard",
      "lastSeenAt": "2024-01-01T00:00:00Z",
      "properties": [
        {
          "key": "string",
          "type": "string",
          "mixed": true,
          "count": 0,
          "declared": true
        }
      ]
    }
  ],
  "sample": {
    "profiles": 0,
    "eventsPerName": 0
  },
  "declared": [
    {
      "id": "string",
      "key": "string",
      "label": "string",
      "type": "text",
      "required": true,
      "hidden": true,
      "defaultValue": {},
      "unique": false,
      "selfServe": false,
      "precision": null,
      "choices": [
        "string"
      ],
      "position": 0,
      "groupKey": "string",
      "listIds": [],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "generatedAt": "2024-01-01T00:00:00Z",
  "cached": true
}

Schema

standardobject[]required

Show child parameters

keystringrequired

typestringrequired

customobject[]required

Show child parameters

keystringrequired

typestringrequired

mixedbooleanrequired

countintegerrequired

eventsobject[]required

Show child parameters

namestringrequired

categorystringrequired

standard | custom

lastSeenAtstringrequired

propertiesobject[]required

Show child parameters

keystringrequired

typestringrequired

mixedbooleanrequired

countintegerrequired

declaredbooleanrequired

sampleobjectrequired

Show child parameters

profilesintegerrequired

eventsPerNameintegerrequired

declaredItemsItem9[]

Show child parameters

idstringrequired

keystringrequired

labelstringrequired

typestringrequired

requiredbooleanrequired

hiddenbooleanrequired

defaultValuerequired

uniquebooleanrequired

= false

selfServebooleanrequired

= false

precisionintegerrequired

= null

choicesstring[]required

positionintegerrequired

groupKeystringrequired

listIdsstring[]required

= []

createdAtstringrequired

generatedAtstringrequired

cachedbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

DELETEhttps://hermeticor.com/v1/attributes/fields/{key}/choices/{option}

Remove one choice from an enum / multi_enum field and from every profile that holds it

Parameters

keystringpathrequired

optionstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/attributes/fields/{key}/choices/{option}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "key": "string",
  "label": "string",
  "type": "text",
  "required": true,
  "hidden": true,
  "defaultValue": {},
  "unique": false,
  "selfServe": false,
  "precision": null,
  "choices": [
    "string"
  ],
  "position": 0,
  "groupKey": "string",
  "listIds": [],
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

keystringrequired

labelstringrequired

typestringrequired

requiredbooleanrequired

hiddenbooleanrequired

defaultValuerequired

uniquebooleanrequired

= false

selfServebooleanrequired

= false

precisionintegerrequired

= null

choicesstring[]required

positionintegerrequired

groupKeystringrequired

listIdsstring[]required

= []

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

GEThttps://hermeticor.com/v1/fields/{object}

Fields of one object: "contact" for contact fields, or a custom object type key

Parameters

objectstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "object": "string",
  "items": [
    {
      "key": "string",
      "type": "string"
    }
  ]
}

Schema

objectstringrequired

itemsobject[]required

Show child parameters

keystringrequired

typestringrequired

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

GEThttps://hermeticor.com/v1/segment-snapshots/{id}/contacts

The people frozen in a snapshot

Parameters

limitintegerquery

= 50

afterstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "email": "string",
      "phone": "string",
      "firstName": "string",
      "lastName": "string"
    }
  ],
  "nextAfter": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

emailstringrequired

phonestringrequired

firstNamestringrequired

lastNamestringrequired

nextAfterstringrequired

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

GEThttps://hermeticor.com/v1/segment-snapshots/{id}/export

CSV of the people frozen in a snapshot

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

POSThttps://hermeticor.com/v1/segments/manual

Create a hand-picked segment from people or email addresses (a list plus a segment that follows it). Adding someone to a list grants no consent.

Request body

application/json

namestringrequired

descriptionstring

profileIdsstring[]

= []

emailsstring[]

= []

{
  "name": "string",
  "description": "string",
  "profileIds": [],
  "emails": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/segments/manual" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","profileIds":[],"emails":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "listId": "string",
  "added": 0,
  "notFound": [
    "string"
  ]
}

Schema

idstringrequired

namestringrequired

listIdstringrequired

addedintegerrequired

notFoundstring[]required

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/diff

Next part

Updated Nov 8, 2026

Was this page helpful?