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

The Invitation of a new User to join the Yousign organization.

YouSign User Invitation 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 Invitation. 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 3 operations across 3 paths, and defines 13 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.

3 operations 3 paths 13 schemas 3 GET

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 Invitation API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

User Invitation 3

The Invitation of a new User to join the Yousign organization.

GET
/users/invitations
List User Invitations
get-invitations 3 params → 200400401403405429500
GET
/users/invitations/{invitationId}
Get an Invitation
get-users-invitation-invitationId 1 param → 200401403404405429500
GET
/users/{userId}/invitation
Get a User Invitation via the User
get-users-userId-invitation 1 param → 200401403404405429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are UserInvitation (6 properties), get_invitations_200_response (2 properties), UnauthorizedResponse (2 properties), ForbiddenResponse (2 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
TooManyRequestsResponse
object
1 property 1 required
UserInvitation
object
6 properties 6 required
MethodNotAllowed
object
1 property 1 required
User_workspaces_inner
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.
get_invitations_200_response
object
2 properties
Pagination
object
Metadata about the response.
1 property 1 required
ManageableRole
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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