scores

Embed

<a href="https://hermeticor.com/docs/ref-scores"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/d3d23010-adbe-427d-b622-102d526ba405/social-card.svg?v=3e7ae33eec8b" alt="scores" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/scores/{id}/companies

Company scores rolled up from their contacts (sum, max or average), highest first

Parameters

aggstringquery

sum | max | avg = sum

limitintegerquery

= 100

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "companyId": "string",
      "value": 0,
      "contacts": 0,
      "tier": "string"
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

companyIdstringrequired

valuenumberrequired

contactsintegerrequired

tierstringrequired

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/scores/{id}/companies

GEThttps://hermeticor.com/v1/scores/{id}/draft

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "rules": [],
  "actions": [],
  "decay": {
    "points": 0,
    "everyDays": 0
  },
  "floor": 0,
  "ceiling": 0,
  "groups": [],
  "tiers": []
}

Schema

rulesRulesItem3[]required

= []

actionsActionsItem[]required

= []

decayobject

Show child parameters

pointsintegerrequired

everyDaysintegerrequired

floorintegerrequired

= 0

ceilinginteger

groupsGroupsItem[]required

= []

Show child parameters

idstringrequired

namestringrequired

limitinteger

tiersTiersItem[]required

= []

Show child parameters

labelstringrequired

minintegerrequired

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

PUThttps://hermeticor.com/v1/scores/{id}/draft

Parameters

idstringpathrequired

Request body

application/json

namestring

definitionobjectrequired

Show child parameters

rulesRulesItem4[]

= []

actionsActionsItem2[]

= []

decayobject

Show child parameters

pointsintegerrequired

everyDaysintegerrequired

floorinteger

= 0

ceilinginteger

groupsGroupsItem2[]

= []

Show child parameters

idstringrequired

namestringrequired

limitinteger

tiersTiersItem2[]

= []

Show child parameters

labelstringrequired

minintegerrequired

{
  "name": "string",
  "definition": {
    "rules": [],
    "actions": [],
    "decay": {
      "points": 0,
      "everyDays": 0
    },
    "floor": 0,
    "ceiling": 0,
    "groups": [],
    "tiers": []
  }
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/scores/{id}/draft" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","definition":{"rules":[],"actions":[],"decay":{"points":0,"everyDays":0},"floor":0,"ceiling":0,"groups":[],"tiers":[]}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "key": "string",
  "status": "draft",
  "draft": {
    "rules": [],
    "actions": [],
    "decay": {
      "points": 0,
      "everyDays": 0
    },
    "floor": 0,
    "ceiling": 0,
    "groups": [],
    "tiers": []
  },
  "published": {
    "rules": [],
    "actions": [],
    "decay": {
      "points": 0,
      "everyDays": 0
    },
    "floor": 0,
    "ceiling": 0,
    "groups": [],
    "tiers": []
  },
  "publishedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

keystringrequired

statusstringrequired

draft | active | inactive

draftobjectrequired

Show child parameters

rulesRulesItem3[]required

= []

actionsActionsItem[]required

= []

decayobject

Show child parameters

pointsintegerrequired

everyDaysintegerrequired

floorintegerrequired

= 0

ceilinginteger

groupsGroupsItem[]required

= []

Show child parameters

idstringrequired

namestringrequired

limitinteger

tiersTiersItem[]required

= []

Show child parameters

labelstringrequired

minintegerrequired

publishedobjectrequired

Show child parameters

rulesRulesItem3[]required

= []

actionsActionsItem[]required

= []

decayobject

Show child parameters

pointsintegerrequired

everyDaysintegerrequired

floorintegerrequired

= 0

ceilinginteger

groupsGroupsItem[]required

= []

Show child parameters

idstringrequired

namestringrequired

limitinteger

tiersTiersItem[]required

= []

Show child parameters

labelstringrequired

minintegerrequired

publishedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

POSThttps://hermeticor.com/v1/scores/{id}/adjust

Add or take points from one contact (history reason manual)

Parameters

idstringpathrequired

Request body

application/json

profileIdstringrequired

deltainteger

operatorstring

add | set | multiply | divide = add

amountnumber

reasonstring

{
  "profileId": "string",
  "delta": 0,
  "operator": "add",
  "amount": 0,
  "reason": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/scores/{id}/adjust" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","delta":0,"operator":"add","amount":0,"reason":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "modelId": "string",
  "profileId": "string",
  "value": 0
}

Schema

modelIdstringrequired

profileIdstringrequired

valueintegerrequired

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

POSThttps://hermeticor.com/v1/scores/{id}/draft/publish

Make the draft the running model

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/scores/{id}/draft

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

POSThttps://hermeticor.com/v1/scores/{id}/draft/reset

Throw the draft away: back to the published model

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/scores/{id}/draft

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

POSThttps://hermeticor.com/v1/scores/{id}/deactivate

Stop scoring; values and history are kept

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/scores/{id}/draft

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

POSThttps://hermeticor.com/v1/scores/{id}/recompute

Rebuild every contact's value in the background from the last 90 days of events and current attributes (the first publish does this too); manual adjustments are dropped

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/scores/{id}/draft

4XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

5XX Default Response

Same as 4XX · GET /v1/scores/{id}/companies

Next part

Updated Nov 8, 2026

Was this page helpful?