Your API key

Create one in the portal under API keys.

Browse the API

API reference

Organisation

Your organisation’s details, the company defaults used in signatures, and usage counts.

Organisation

GET/api/v1/organisation

Get the organisation

Returns the organisation the key belongs to.

organisation:read

This endpoint takes no parameters beyond the URL itself.

Example response

json

{
  "organisation": {
    "id": "5f1c0f7e-6f1a-4a5e-9d2b-2a1c3d4e5f60",
    "name": "Your Company",
    "slug": "your-company-4b2f1c",
    "domain": "domain.com",
    "logo_url": "https://signed.ci/uploads/2f8b1c9e.png",
    "created_at": "2026-03-04T09:12:00.000Z"
  },
  "plan": {
    "status": "active",
    "plan_id": "standard",
    "plan_name": "Standard"
  },
  "usage": {
    "users": 68,
    "templates": 6,
    "members": 3,
    "pending_invitations": 1
  }
}

Copy and paste

curl -X GET "https://api.usesigned.co.uk/api/v1/organisation" \
  -H "X-API-Key: $SIGNED_API_KEY"

PATCH/api/v1/organisation

Update the organisation

Changes the name, the email domain used to match people, or the logo. Send only the fields you want to change.

organisation:write

Parameters

JSON body

nameOptional
stringOrganisation name.
up to 255 characters
example: "Your Company Ltd"
domainOptional
stringEmail domain, without the at sign. Used to match new accounts to the organisation.
up to 255 characters
example: "domain.com"
logo_urlOptional
stringPublic URL of the logo. Also available to signatures as {{logo_url}}.
up to 2000 characters
example: "https://www.domain.com/logo.png"

Example request body

json

{
  "name": "Your Company Ltd",
  "domain": "domain.com"
}

Example response

json

{
  "organisation": {
    "id": "5f1c0f7e-6f1a-4a5e-9d2b-2a1c3d4e5f60",
    "name": "Your Company Ltd",
    "domain": "domain.com"
  }
}

Copy and paste

curl -X PATCH "https://api.usesigned.co.uk/api/v1/organisation" \
  -H "X-API-Key: $SIGNED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Your Company Ltd","domain": "domain.com"}'

GET/api/v1/organisation/usage

Get usage

Current counts against your plan limits, plus the daily signature lookup and stamp counts for the last 30 days.

usage:read

This endpoint takes no parameters beyond the URL itself.

Example response

json

{
  "usage": {
    "users": 68,
    "templates": 6,
    "members": 3,
    "pending_invitations": 1
  },
  "limits": {
    "users": null,
    "templates": null,
    "members": null
  },
  "lookups_this_month": 4182,
  "daily": [
    {
      "day": "2026-09-24",
      "lookups": 213,
      "stamps": 41
    }
  ]
}

Copy and paste

curl -X GET "https://api.usesigned.co.uk/api/v1/organisation/usage" \
  -H "X-API-Key: $SIGNED_API_KEY"

Settings

GET/api/v1/organisation/settings

Get settings

The editable settings for the organisation, such as the company defaults and the legal disclaimer.

organisation:read

This endpoint takes no parameters beyond the URL itself.

Example response

json

{
  "company_name": "Your Company Ltd",
  "company_website": "www.domain.com",
  "company_address": "1 Example Street, Anytown, AB1 2CD",
  "disclaimer": "This email and any attachments are confidential.",
  "click_tracking": "true",
  "timezone": "Europe/London"
}

Copy and paste

curl -X GET "https://api.usesigned.co.uk/api/v1/organisation/settings" \
  -H "X-API-Key: $SIGNED_API_KEY"

PATCH/api/v1/organisation/settings

Update settings

Writes editable settings. Any key not in the editable list is ignored rather than rejected, so a round trip of the GET response is safe.

organisation:write

Parameters

JSON body

company_nameOptional
stringDefault company name for {{company}}.
up to 255 characters
company_websiteOptional
stringDefault website for {{website}}.
up to 255 characters
company_addressOptional
stringDefault address for {{address}}.
up to 255 characters
disclaimerOptional
stringSmall print added under every signature.
up to 5000 characters
click_trackingOptional
one ofWhether links in signatures and banners are counted. Scanner clicks are filtered out either way.
one of: true, false
timezoneOptional
stringIANA time zone that dated rules and blocks follow, such as Europe/London. An unknown zone is rejected with 400.
up to 64 characters

Example request body

json

{
  "company_name": "Your Company Ltd",
  "disclaimer": "Confidential. If you received this in error, please delete it."
}

Example response

json

{
  "updated": [
    "company_name",
    "disclaimer"
  ]
}

Copy and paste

curl -X PATCH "https://api.usesigned.co.uk/api/v1/organisation/settings" \
  -H "X-API-Key: $SIGNED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_name": "Your Company Ltd","disclaimer": "Confidential. If you received this in error, please delete it."}'

Worth knowing

Azure and Google credentials, the client key and the add-in ID are managed by the server and cannot be set here.