API reference

Account and workspace

Who the key acts as, and the workspace it belongs to.

Endpoints · 4

GET Who am I
GET List workspaces
GET Retrieve the workspace
PATCH Update the workspace

The object

Field	Type	Description
`id`	string	Unique ID, starting with wsp_.
`name`	string	From your organization in your sign-in provider.
`brand_name, brand_color`	string or null	Branding shown to recipients. Set in the app.
`default_expires_in_days`	integer	Default expiry for new documents.
`reminder_every_days`	integer or null	Default reminders.
`internal_domains`	array	Your organization’s email domains, used by approval rules.
`embed_origins`	array	Sites allowed to show the signing page in a frame.
`created_at`	timestamp

GET/users/me

Who am I

The person the key acts as.

Request

bash

curl "https://api.esorasign.com/v1/users/me" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{ "id": "usr_4tDdO9eGzMcNU77sVTUUJ5", "object": "user", "name": "John Smith", "email": "john.smith@example.com", "api_key_id": "key_0P3C4DSA7Lc360a9Y6yNd1" }

GET/workspaces

List workspaces

The key’s workspace.

Request

bash

curl "https://api.esorasign.com/v1/workspaces" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{
  "object": "list",
  "data": [
    {
      "id": "wsp_16lLlGUriAX1DyyXN9iYw1",
      "object": "workspace",
      "name": "Northwind Traders",
      "brand_name": "Northwind",
      "brand_color": "#1F4E79",
      "default_expires_in_days": 30,
      "reminder_every_days": 3,
      "internal_domains": ["northwind.example"],
      "embed_origins": ["https://portal.northwind.example"],
      "created_at": "2026-07-14T08:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/workspaces/{id}

Retrieve the workspace

Request

bash

curl "https://api.esorasign.com/v1/workspaces/wsp_16lLlGUriAX1DyyXN9iYw1" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{
  "id": "wsp_16lLlGUriAX1DyyXN9iYw1",
  "object": "workspace",
  "name": "Northwind Traders",
  "brand_name": "Northwind",
  "brand_color": "#1F4E79",
  "default_expires_in_days": 30,
  "reminder_every_days": 3,
  "internal_domains": ["northwind.example"],
  "embed_origins": ["https://portal.northwind.example"],
  "created_at": "2026-07-14T08:30:00.000Z"
}

PATCH/workspaces/{id}

Update the workspace

Other settings (branding, team, approval rules, retention) are in the app.

Parameter	Type		Description
`embed_origins`	array	optional	Up to 20 origins like https://portal.example.com (http://localhost for development).
`default_expires_in_days`	integer	optional	1 to 365.

Request

bash

curl -X PATCH "https://api.esorasign.com/v1/workspaces/wsp_16lLlGUriAX1DyyXN9iYw1" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "embed_origins": ["https://portal.northwind.example"] }'

Response

json

{
  "id": "wsp_16lLlGUriAX1DyyXN9iYw1",
  "object": "workspace",
  "name": "Northwind Traders",
  "brand_name": "Northwind",
  "brand_color": "#1F4E79",
  "default_expires_in_days": 30,
  "reminder_every_days": 3,
  "internal_domains": ["northwind.example"],
  "embed_origins": ["https://portal.northwind.example"],
  "created_at": "2026-07-14T08:30:00.000Z"
}