Endpoints

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-endpoints"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/30cd59e5-acb1-4277-a050-481f9f4dc46f/social-card.svg?v=3e7ae33eec8b" alt="Endpoints" width="600" height="315"></a>
PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/members/{userId}

Parameters

userIdstringpathrequired

Request body

application/json
rolestringrequired
owner | admin | marketer | sales | analyst | viewer
{
  "role": "owner"
}

Code samples

cURL
curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"owner"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

PUThttps://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/lists

Limit a member to specific lists (null = all lists)

Parameters

userIdstringpathrequired

Request body

application/json
listIdsstring[]required
{
  "listIds": [
    "string"
  ]
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/members/{userId}/lists" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"listIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PATCH /v1/members/{userId}

4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/signup-domains

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/signup-domains" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "allow": [
    "string"
  ],
  "block": [
    "string"
  ]
}
Schema
allowstring[]required
blockstring[]required
4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

PUThttps://hermetica.15.204.158.166.sslip.io/v1/signup-domains

Request body

application/json
allowstring[]required
blockstring[]required
{
  "allow": [
    "string"
  ],
  "block": [
    "string"
  ]
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/signup-domains" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"allow":["string"],"block":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/signup-domains

4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

POSThttps://hermetica.15.204.158.166.sslip.io/v1/invitations/accept

Request body

application/json
tokenstringrequired
{
  "token": "string"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/invitations/accept" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"token":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "workspaceId": "string",
  "role": "string"
}
Schema
workspaceIdstringrequired
rolestringrequired
4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

POSThttps://hermetica.15.204.158.166.sslip.io/v1/invitations/decline

Decline an invitation (the link stops working)

Request body

application/json
tokenstringrequired
{
  "token": "string"
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/invitations/decline" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"token":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PATCH /v1/members/{userId}

4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/workspace

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspace" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "timezone": "string",
  "locale": "string",
  "postalAddress": "string",
  "adminEmail": "string",
  "unsubscribeRedirectUrl": "string",
  "quietHours": {
    "start": "string",
    "end": "string"
  },
  "displayCurrency": "string",
  "fxRates": {},
  "sessionDays": 0,
  "campaignNotifyEmails": [
    "string"
  ],
  "websiteUrl": "string",
  "industry": "string"
}
Schema
idstringrequired
organizationIdstringrequired
namestringrequired
timezonestringrequired
localestringrequired
postalAddressstringrequired
adminEmailstringrequired
unsubscribeRedirectUrlstringrequired
quietHoursobjectrequired
Show child parameters
startstringrequired
endstringrequired
displayCurrencystringrequired
fxRatesobjectrequired
sessionDaysintegerrequired
campaignNotifyEmailsstring[]required
websiteUrlstring
industrystring
4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/workspace

Request body

application/json
namestring
timezonestring
localestring
postalAddressstring
adminEmailstring
unsubscribeRedirectUrlstring
quietHoursobject
Show child parameters
startstringrequired
endstringrequired
displayCurrencystring
fxRatesobject
sessionDaysinteger
campaignNotifyEmailsstring[]
websiteUrlstring
industrystring
ecommerce | saas | agency | media | education | nonprofit | finance | health | travel | real_estate | b2b_services | other
{
  "name": "string",
  "timezone": "string",
  "locale": "string",
  "postalAddress": "string",
  "adminEmail": "string",
  "unsubscribeRedirectUrl": "string",
  "quietHours": {
    "start": "string",
    "end": "string"
  },
  "displayCurrency": "string",
  "fxRates": {},
  "sessionDays": 0,
  "campaignNotifyEmails": [
    "string"
  ],
  "websiteUrl": "string",
  "industry": "ecommerce"
}

Code samples

cURL
curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/workspace" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","timezone":"string","locale":"string","postalAddress":"string","adminEmail":"string","unsubscribeRedirectUrl":"string","quietHours":{"start":"string","end":"string"},"displayCurrency":"string","fxRates":{},"sessionDays":0,"campaignNotifyEmails":["string"],"websiteUrl":"string","industry":"ecommerce"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/workspace

4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/audit

Parameters

limitintegerquery
= 50
cursorstringquery
actionstringquery
targetTypestringquery
fromstringquery
tostringquery

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/audit" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "actorType": "string",
      "actorId": "string",
      "impersonatedBy": "string",
      "action": "string",
      "targetType": "string",
      "targetId": "string",
      "before": {},
      "after": {},
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
actorTypestringrequired
actorIdstringrequired
impersonatedBystring
actionstringrequired
targetTypestringrequired
targetIdstringrequired
beforerequired
afterrequired
atstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/audit/export

Audit log as CSV or NDJSON (max 10,000 rows). A SIEM can poll with order=asc and from=<last timestamp>.

Parameters

actionstringquery
targetTypestringquery
fromstringquery
tostringquery
formatstringquery
csv | ndjson = csv
orderstringquery
asc | desc = desc

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/audit/export" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "filename": "string",
  "format": "csv",
  "rowCount": 0,
  "truncated": true,
  "content": "string"
}
Schema
filenamestringrequired
formatstringrequired
csv | ndjson
rowCountintegerrequired
truncatedbooleanrequired
contentstringrequired
4XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

5XX Default Response

Same as 4XX · PATCH /v1/members/{userId}

Updated