Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouSign Workspace API

A way to partition your Yousign organization into separate entities.

YouSign Workspace API is one of 38 APIs that YouSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, rate-limit docs, and 1 JSON Schema.

This API exposes 7 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 3.0.

Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.

7 operations 3 paths 17 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0
Base URL
https://api.yousign.com/v3
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

YouSign Workspace API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Workspace 7

A way to partition your Yousign organization into separate entities.

GET
/workspaces
List Workspaces
get-workspaces 2 params → 200400401403405429500
POST
/workspaces
Create a Workspace
post-workspace body → 201400401403404405415429
GET
/workspaces/default
Get the default Workspace
get-workspaces-default → 200400401403404405429500
POST
/workspaces/default
Mark the given Workspace as default
markWorkspaceAsDefault body → 204400401403405415429500
DELETE
/workspaces/{workspaceId}
Delete a Workspace
deleteWorkspace 1 param body → 204400401403404405415429
GET
/workspaces/{workspaceId}
Get a Workspace
get-workspaces-workspaceId 1 param → 200400401403404405429500
PATCH
/workspaces/{workspaceId}
Update a Workspace
patch-workspaces-workspaceId 1 param body → 200400401403404405415429

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Workspace (8 properties), ForbiddenResponse (2 properties), BadRequestResponse (2 properties), NotFoundResponse (2 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
DeleteWorkspace
object
1 property 1 required
MarkWorkspaceAsDefault
object
1 property 1 required
Workspace_users_inner
object
1 property
TooManyRequestsResponse
object
1 property 1 required
UpdateWorkspace
object
2 properties
Workspace
object
8 properties 8 required
get_workspaces_200_response
object
2 properties
UnsupportedMediaTypeResponse
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
CreateWorkspace
object
2 properties 1 required
Pagination
object
Metadata about the response.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-workspace-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant API
YouSign Approver API
YouSign Archive API
YouSign Audit Trail API
YouSign Bank Account Lookup Verification API
YouSign Bank Account Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API