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

Categorization tag that can be added to a Signature Request.

YouSign Label 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 Label. 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 8 operations across 4 paths, and defines 16 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.

8 operations 4 paths 16 schemas 2 DELETE3 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 Label API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 8

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

Label 8

Categorization tag that can be added to a Signature Request.

GET
/labels
List Labels
get-labels 3 params → 200400401405429500
POST
/labels
Create a new Label
post-labels body → 201400401403405429500
DELETE
/labels/{labelId}
Delete a Label
delete-labels-id 1 param → 204400401403404405429500
GET
/labels/{labelId}
Get a Label
get-labels-id 1 param → 200400401403404405429500
PATCH
/labels/{labelId}
Update a Label
patch-label-id 1 param body → 200400401403404405415429
GET
/signature_requests/{signatureRequestId}/labels
List Labels of a Signature Request
get-signature_requests-id-labels 1 param → 200400401403404405429500
DELETE
/signature_requests/{signatureRequestId}/labels/{labelId}
Remove Label from a Signature Request
delete-signature_requests-id-labels-id 2 params → 204400401403404405429500
PUT
/signature_requests/{signatureRequestId}/labels/{labelId}
Associate a Label with a Signature Request
put-signature_requests-id-labels-id 2 params → 204400401403404405429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Label (3 properties), BadRequestResponse (2 properties), SignatureRequestLabel (2 properties), get_signature_requests_id_labels_200_response (2 properties). Each schema is shown below with its type and property counts.

SignatureRequestLabel
object
2 properties 2 required
UpdateLabel
object
1 property 1 required
InternalServerError
object
2 properties 2 required
TooManyRequestsResponse
object
1 property 1 required
CreateLabel
object
1 property 1 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
get_signature_requests_id_labels_200_response
object
2 properties
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.
Label
object
3 properties 3 required
get_labels_200_response
object
2 properties
Pagination
object
Metadata about the response.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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