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 User API

A person who can access the Yousign web app of your organization.

YouSign User 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 User. 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 19 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 19 schemas 2 DELETE2 GET1 PATCH1 POST1 PUT

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 User 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 — 2 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User 7

A person who can access the Yousign web app of your organization.

GET
/users
List Users
get-users 3 params → 200400401405429500
POST
/users
Create a new User
post-users body → 201400401403405429500
DELETE
/users/{userId}
Delete a User
delete-users-userId 1 param → 204400401403404405429500
GET
/users/{userId}
Get a User
get-users-userId 1 param → 200400401403404405429500
PATCH
/users/{userId}
Update a User
patch-users-userId 1 param body → 200400401403404405415429
DELETE
/workspaces/{workspaceId}/users/{userId}
Remove a user from a workspace
delete-workspace-workspaceId-users-userId 2 params → 204400401403404405429500
PUT
/workspaces/{workspaceId}/users/{userId}
Associate a user to a workspace
put-workspaces-workspaceId-Users 2 params → 204400401403404405429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), CreateUser (8 properties), UpdateUser (2 properties), BadRequestResponse (2 properties). Each schema is shown below with its type and property counts.

HumanName
string
InternalServerError
object
2 properties 2 required
TooManyRequestsResponse
object
1 property 1 required
UserRole
string
UpdateUser
object
2 properties
UnsupportedMediaTypeResponse
object
2 properties 2 required
get_users_200_response
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
Locale
string
Locale settings used for communication.
NotFoundResponse
object
2 properties 2 required
User_workspaces_inner
object
1 property 1 required
BadRequestResponse
object
2 properties 2 required
CreateUser
object
8 properties 4 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
User
object
14 properties 14 required
Pagination
object
Metadata about the response.
1 property 1 required
UserStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-user-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