User Invitation

Learn how to manage your User Invitations via API.

Overview

The User Invitation resource designates the invitation of a new User to join your Yousign organization.

Using the API, you can retrieve User Invitations to access their expiration dates and view the new User’s configuration settings—such as email address, assigned workspaces, and role.

There are two ways User Invitation are created:

  • From the API, when creating a new User with the POST /users endpoint. In that case the User Invitation resource is associated to the User resource.
  • From the app, (see article). In that case the User Invitation stands alone, without any associated User resource.

🚧

User Invitations are not accessible from the Sandbox environment.

Get information about User Invitation

List all the Users Invitations in your organization with the GET /users/invitations endpoint.

Retrieve a specific User Invitation with the GET /users/invitations/{invitationId} endpoint.

Retrieve a User Invitation via its associated User with the GET /users/{userId}/invitation endpoint.