platform

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-platform"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/321b0769-f874-4137-9e26-67f97f7ed220/social-card.svg?v=3e7ae33eec8b" alt="platform" width="600" height="315"></a>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/account-exports

Parameters

limitintegerquery

= 25

cursorstringquery

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/account-exports" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "status": "queued",
      "error": "string",
      "sizeBytes": 0,
      "datasets": {},
      "createdAt": "2024-01-01T00:00:00Z",
      "finishedAt": "2024-01-01T00:00:00Z",
      "downloadPath": "string",
      "options": {
        "datasets": [
          "string"
        ],
        "since": "string"
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

statusstringrequired

queued | running | completed | failed

errorstringrequired

sizeBytesintegerrequired

datasetsobjectrequired

createdAtstringrequired

finishedAtstringrequired

downloadPathstringrequired

optionsobject

Show child parameters

datasetsstring[]

sincestring

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/account-exports

POSThttps://hermetica.15.204.158.166.sslip.io/v1/account-exports

Export the whole workspace (profiles, segments, campaigns, templates, flows, forms, suppressions, events, lists) as a zip of NDJSON plus manifest

Request body

application/json

datasetsstring[]

sincestring

{
  "datasets": [
    "profiles"
  ],
  "since": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/account-exports" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"datasets":["profiles"],"since":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "status": "queued",
  "error": "string",
  "sizeBytes": 0,
  "datasets": {},
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z",
  "downloadPath": "string",
  "options": {
    "datasets": [
      "string"
    ],
    "since": "string"
  }
}

Schema

idstringrequired

statusstringrequired

queued | running | completed | failed

errorstringrequired

sizeBytesintegerrequired

datasetsobjectrequired

createdAtstringrequired

finishedAtstringrequired

downloadPathstringrequired

optionsobject

Show child parameters

datasetsstring[]

sincestring

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

GEThttps://hermetica.15.204.158.166.sslip.io/v1/account-exports/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/account-exports/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/account-exports

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

GEThttps://hermetica.15.204.158.166.sslip.io/v1/account-exports/{id}/download

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/account-exports/{id}/download" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

GEThttps://hermetica.15.204.158.166.sslip.io/v1/oauth/clients

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/oauth/clients" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "clientId": "string",
      "name": "string",
      "redirectUris": [
        "string"
      ],
      "scopes": [
        "string"
      ],
      "isPublic": true,
      "revokedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

clientIdstringrequired

namestringrequired

redirectUrisstring[]required

scopesstring[]required

isPublicbooleanrequired

revokedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

POSThttps://hermetica.15.204.158.166.sslip.io/v1/oauth/clients

Register an OAuth client; the secret is shown once

Request body

application/json

namestringrequired

redirectUrisstring[]required

scopesstring[]required

publicboolean

= false

{
  "name": "string",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "public": false
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/oauth/clients" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","redirectUris":["string"],"scopes":["string"],"public":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "clientId": "string",
  "name": "string",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "isPublic": true,
  "revokedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "clientSecret": "string"
}

Schema

idstringrequired

clientIdstringrequired

namestringrequired

redirectUrisstring[]required

scopesstring[]required

isPublicbooleanrequired

revokedAtstringrequired

createdAtstringrequired

clientSecretstringrequired

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/oauth/clients/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/oauth/clients/{id}" \
  -H "Authorization: Bearer $SSLIP_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/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

GEThttps://hermetica.15.204.158.166.sslip.io/v1/oauth/authorize

Validate an authorization request and describe what the app asks for

Parameters

client_idstringqueryrequired

redirect_uristringqueryrequired

scopestringquery

statestringquery

code_challengestringqueryrequired

code_challenge_methodstringqueryrequired

S256

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/oauth/authorize?client_id=<client_id>&redirect_uri=<redirect_uri>&code_challenge=<code_challenge>&code_challenge_method=S256"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "clientName": "string",
  "clientId": "string",
  "scopes": [
    "string"
  ],
  "redirectUri": "string"
}

Schema

clientNamestringrequired

clientIdstringrequired

scopesstring[]required

redirectUristringrequired

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

POSThttps://hermetica.15.204.158.166.sslip.io/v1/oauth/authorize

The user approved: returns the redirect URL carrying the single-use code (PKCE S256 required)

Request body

application/json

client_idstringrequired

redirect_uristringrequired

scopestring

statestring

code_challengestringrequired

code_challenge_methodstringrequired

S256

{
  "client_id": "string",
  "redirect_uri": "string",
  "scope": "",
  "state": "string",
  "code_challenge": "string",
  "code_challenge_method": "S256"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/oauth/authorize" \
  -H "Content-Type: application/json" \
  -d '{"client_id":"string","redirect_uri":"string","scope":"","state":"string","code_challenge":"string","code_challenge_method":"S256"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "redirectUrl": "string"
}

Schema

redirectUrlstringrequired

4XX Default Response

Same as 4XX · GET /v1/account-exports

5XX Default Response

Same as 4XX · GET /v1/account-exports

Next part

Updated Nov 3, 2026

Was this page helpful?