Skip to content
/
Get a user

Signable API (1.0.0)

The Signable API provides secure and efficient access to Signable's electronic signature platform. With this RESTful API, you can send documents for signature, manage templates, track envelope status, and automate your document workflows from within your own applications.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Signable

help@signable.co.uk

License

Proprietary

Terms of Service

Languages
Servers
Production server

https://api.signable.co.uk/v1/

Partners

Manage partner integrations.

Operations

Envelopes

Send, track, and manage documents for e-signature.

Operations

Templates

Create and reuse predefined document templates.

Operations

Contacts

Manage contact details for signers and stakeholders.

Operations

Users

Control user accounts and roles.

Operations

List users

Request

Retrieves a paginated list of all users in your account. You can control pagination using the offset and limit query parameters.

Security
basicAuth
Query
offsetinteger

The index of the first envelope to retrieve.

Default 0
Example: offset=0
limitinteger[ 1 .. 50 ]

The maximum number of envelopes to return. If more than 50 is requested, 10 will be returned instead.

Default 10
curl -i -X GET \
  -u <username>:<password> \
  'https://api.signable.co.uk/v1/users?offset=0&limit=10'

Responses

Users list returned successfully

Bodyapplication/json
httpinteger
Example: 200
offsetinteger
Example: 0
limitinteger
Example: 50
total_usersstring

Total number of users (returned as a string)

Example: "2"
usersArray of objects(User)
Response
application/json
{
  "http": 200,
  "offset": 0,
  "limit": 50,
  "total_users": "2",
  "users": [
    { … },
    { … }
  ]
}

Create a user

Request

Adds a new user to your account. You must provide the user’s name, email address, and their role ID.

Security
basicAuth
Bodyapplication/jsonrequired
user_namestringrequired
Example: "Abby Example"
user_emailstring(email)required
Example: "abby+example@wearedom.com"
role_idstringrequired

Role assigned to the user:

  • "1" = User
  • "2" = Admin
  • "3" = Super-Admin
Enum"1""2""3"
Example: "2"
curl -i -X POST \
  -u <username>:<password> \
  https://api.signable.co.uk/v1/users \
  -H 'Content-Type: application/json' \
  -d '{
    "user_name": "Abby Example",
    "user_email": "abby+example@wearedom.com",
    "role_id": "2"
  }'

Responses

User created successfully

Bodyapplication/json
httpinteger
Example: 200
messagestring
Example: "Abby Example has been added to your user list."
hrefstring(uri)
Example: "https://api.signable.co.uk/v1/users/837146"
user_idstring
Example: "837146"
role_idstring

Role assigned to the user:

  • "1" = User
  • "2" = Admin
  • "3" = Super-Admin
Enum"1""2""3"
Example: "1"
user_namestring
Example: "Abby Example"
user_emailstring(email)
Example: "abby+example@wearedom.com"
user_addedstring(date-time)
Example: "2025-07-07T08:06:49+0000"
Response
application/json
{
  "http": 200,
  "message": "Abby Example has been added to your user list.",
  "href": "https://api.signable.co.uk/v1/users/837146",
  "user_id": "837146",
  "role_id": "2",
  "user_name": "Abby Example",
  "user_email": "abby+example@wearedom.com",
  "user_added": "2025-07-07T08:06:49+0000"
}

Get a user

Request

Retrieves the details of a single user by their unique user_id. The response includes the user's name, email, role, and timestamps.

Security
basicAuth
Path
user_idintegerrequired

The unique ID of the user to retrieve

Example: 836499
curl -i -X GET \
  -u <username>:<password> \
  https://api.signable.co.uk/v1/users/836499

Responses

User details returned successfully

Bodyapplication/json
httpinteger
Example: 200
user_idinteger
Example: 836499
role_idstring

Role assigned to the user:

  • "1" = User
  • "2" = Admin
  • "3" = Super-Admin
Enum"1""2""3"
Example: "3"
user_namestring
Example: "Abby Loves Signable"
user_emailstring(email)
Example: "abby+010725@signable.co.uk"
user_addedstring(date-time)
Example: "2025-07-01T08:40:38+0000"
user_last_updatedstring(date-time)
Example: "2025-07-07T07:57:54+0000"
Response
application/json
{
  "http": 200,
  "user_id": 836499,
  "role_id": "3",
  "user_name": "Abby Loves Signable",
  "user_email": "abby+010725@signable.co.uk",
  "user_added": "2025-07-01T08:40:38+0000",
  "user_last_updated": "2025-07-07T07:57:54+0000"
}

Update a user

Request

Updates an existing user by their user_id. You can change their name, email address, or assigned role.

Security
basicAuth
Path
user_idintegerrequired

The unique ID of the user to update

Example: 837154
Bodyapplication/jsonrequired
user_namestringrequired
Example: "Abby Smith"
user_emailstring(email)required
Example: "abby+jackson@signable.co.uk"
role_idstringrequired

Role assigned to the user:

  • "1" = User
  • "2" = Admin
  • "3" = Super-Admin
Enum"1""2""3"
Example: "1"
curl -i -X PUT \
  -u <username>:<password> \
  https://api.signable.co.uk/v1/users/837154 \
  -H 'Content-Type: application/json' \
  -d '{
    "user_name": "Abby Smith",
    "user_email": "abby+jackson@signable.co.uk",
    "role_id": "1"
  }'

Responses

User updated successfully

Bodyapplication/json
httpinteger
Example: 200
messagestring
Example: "Abby Smith has been updated in your user list."
hrefstring(uri)
Example: "https://api.signable.co.uk/v1/users/837154"
user_idinteger
Example: 837154
role_idstring
Enum"1""2""3"
Example: "1"
user_namestring
Example: "Abby Smith"
user_emailstring(email)
Example: "abby+jackson@signable.co.uk"
user_updatedstring(date-time)
Example: "2025-07-07T08:38:54+0000"
Response
application/json
{
  "http": 200,
  "message": "Abby Smith has been updated in your user list.",
  "href": "https://api.signable.co.uk/v1/users/837154",
  "user_id": 837154,
  "role_id": "1",
  "user_name": "Abby Smith",
  "user_email": "abby+jackson@signable.co.uk",
  "user_updated": "2025-07-07T08:38:54+0000"
}

Delete a user

Request

Removes a user from your account using their user_id. The response confirms the deletion and includes the user's basic details.

Security
basicAuth
Path
user_idintegerrequired

The unique ID of the user to delete

Example: 837154
curl -i -X DELETE \
  -u <username>:<password> \
  https://api.signable.co.uk/v1/users/837154

Responses

User deleted successfully

Bodyapplication/json
httpinteger
Example: 200
messagestring
Example: "Abby Smith has been removed from your user list."
user_idinteger
Example: 837154
role_idstring

Role previously assigned to the deleted user:

  • "1" = User
  • "2" = Admin
  • "3" = Super-Admin
Enum"1""2""3"
Example: "1"
user_emailstring(email)
Example: "abby+jackson@signable.co.uk"
user_namestring
Example: "Abby Smith"
Response
application/json
{
  "http": 200,
  "message": "Abby Smith has been removed from your user list.",
  "user_id": 837154,
  "role_id": "1",
  "user_email": "abby+jackson@signable.co.uk",
  "user_name": "Abby Smith"
}

Branding

Customize visual and branding settings for emails.

Operations

Settings

Configure account-wide preferences and defaults.

Operations

Webhooks

Receive real-time notifications about document events.

OperationsWebhooks