API applications API

GET /api_applications/{id}

Get an API application

Branding and callback configuration for an embedded partner application.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Path parameters

Responses

Example request

curl -X GET https://api.signclad.com/api/v1/api_applications/{id} \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"

Example response (200)

{
  "id": "5c1d9e7f-2a3b-4c5d-8e9f-0a1b2c3d4e5f",
  "name": "Acme Lending portal",
  "callback_urls": [
    "https://portal.acme.example/signclad/callback"
  ],
  "primary_color": "#1F6FEB",
  "button_text_color": "#FFFFFF",
  "link_text_color": "#1F6FEB",
  "buttons_border_radius": 8,
  "custom_logo_file": "https://files.signclad.com/branding/acme-logo.png",
  "allowed_embed_domains": [
    "portal.acme.example"
  ],
  "owner": {
    "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "name": "Bryce Matheson",
    "email": "[email protected]"
  },
  "created_at": "2026-04-02T08:15:00Z",
  "updated_at": "2026-08-20T14:03:22Z"
}

PATCH /api_applications/{id}

Update an API application Extension

Only the keys present change; a key present and null clears it. Colours are hex, origins are scheme-and-host, and default_webhook_id must name an endpoint in this workspace.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Path parameters

Request body

application/json

Responses

Example request

curl -X PATCH https://api.signclad.com/api/v1/api_applications/{id} \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"

DELETE /api_applications/{id}

Delete an API application

API applications are created in the web app; there is no create endpoint. Deleting one detaches it from its documents and stops its embedded pages from loading.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Path parameters

Responses

Example request

curl -X DELETE https://api.signclad.com/api/v1/api_applications/{id} \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"

GET /api_applications

List API applications Extension

Every application in the workspace. next_cursor is always null here even when has_more is true — the list is capped rather than paged, so raise limit instead of following a cursor.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Query parameters

Responses

Example request

curl -X GET https://api.signclad.com/api/v1/api_applications \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"

POST /api_applications

Create an API application Extension

Branding and embed configuration for a partner integration. callback_urls and allowed_embed_domains are origins — scheme and host, no path — and are normalized on write; setting callback_urls without mentioning allowed_embed_domains keeps the two in step.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Request body

application/json

Responses

Example request

curl -X POST https://api.signclad.com/api/v1/api_applications \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"

POST /api_applications/{id}/logo

Upload an application logo Extension

PNG, JPEG, WebP, or GIF, up to 2 MB. SVG is deliberately refused — it is a script vector, and this image is rendered inside other people's pages.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Path parameters

Request body

multipart/form-data

Responses

Example request

curl -X POST https://api.signclad.com/api/v1/api_applications/{id}/logo \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"

DELETE /api_applications/{id}/logo

Remove an application logo Extension

Falls back to the workspace's logo, then to none.

Base URL

https://api.signclad.com/api/v1

Authentication

API key or OAuth 2.1 access token

Path parameters

Responses

Example request

curl -X DELETE https://api.signclad.com/api/v1/api_applications/{id}/logo \
  -H "X-Api-Key: $SIGNCLAD_API_KEY"