Skip to content

Repository files navigation

SignRequest - the C# library for SignRequest.com

NuGet version

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext
  • UWP >=10.0

Dependencies

  • FubarCoder.RestSharp.Portable.Core >=4.0.7
  • FubarCoder.RestSharp.Portable.HttpClient >=4.0.7
  • Newtonsoft.Json >=10.0.3

Installation

NuGet

The SignRequest API client can be installed using NuGet with the package name SignRequest.

API Documentation

Full API documentation, including code samples, can be found here: https://signrequest.com/api/v1/docs/

Getting Started

usingSystem;usingSystem.Diagnostics;usingSignRequest.Api;usingSignRequest.Client;usingSignRequest.Model;namespaceExample{publicclassDocumentsCreateExample{publicvoidmain(){// Configure API key authorization: TokenConfiguration.Default.AddApiKey("Authorization","YOUR_API_KEY");Configuration.Default.AddApiKeyPrefix("Authorization","Token");varapiInstance=newDocumentsApi();vardata=newDocument();data.FileFromUrl="https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing";try{Documentresult=apiInstance.DocumentsCreate(data);Debug.WriteLine(result);}catch(Exceptione){Debug.Print("Exception when calling DocumentsApi.DocumentsCreate: "+e.Message);}}}}

Documentation for API Endpoints

All URIs are relative to https://signrequest.com/api/v1

ClassMethodHTTP requestDescription
ApiTokensApiApiTokensListGET /api-tokens/Retrieve a list of API tokens
DocumentAttachmentsApiDocumentAttachmentsCreatePOST /document-attachments/Create a Document Attachment
DocumentAttachmentsApiDocumentAttachmentsListGET /document-attachments/Retrieve a list of Document Attachments
DocumentAttachmentsApiDocumentAttachmentsReadGET /document-attachments/{uuid}/Retrieve a Document Attachment
DocumentsApiDocumentsCreatePOST /documents/Create a Document
DocumentsApiDocumentsDeleteDELETE /documents/{uuid}/Delete a Document
DocumentsApiDocumentsListGET /documents/Retrieve a list of Documents
DocumentsApiDocumentsReadGET /documents/{uuid}/Retrieve a Document
DocumentsSearchApiDocumentsSearchListGET /documents-search/Search documents
EventsApiEventsListGET /events/Retrieve a list of Events
EventsApiEventsReadGET /events/{id}/Retrieve an Event
SignrequestQuickCreateApiSignrequestQuickCreateCreatePOST /signrequest-quick-create/Quick create a SignRequest
SignrequestsApiSignrequestsCancelSignrequestPOST /signrequests/{uuid}/cancel_signrequest/Cancel a SignRequest
SignrequestsApiSignrequestsCreatePOST /signrequests/Create a SignRequest
SignrequestsApiSignrequestsListGET /signrequests/Retrieve a list of SignRequests
SignrequestsApiSignrequestsReadGET /signrequests/{uuid}/Retrieve a SignRequest
SignrequestsApiSignrequestsResendSignrequestEmailPOST /signrequests/{uuid}/resend_signrequest_email/Resend a SignRequest
TeamMembersApiTeamMembersListGET /team-members/Retrieve a list of Team Members
TeamMembersApiTeamMembersReadGET /team-members/{uuid}/Retrieve a Team Member
TeamsApiTeamsCreatePOST /teams/Create a Team
TeamsApiTeamsDeleteDELETE /teams/{subdomain}/Delete a Team
TeamsApiTeamsInviteMemberPOST /teams/{subdomain}/invite_member/Invite a Team Member
TeamsApiTeamsListGET /teams/Retrieve a list of Teams
TeamsApiTeamsPartialUpdatePATCH /teams/{subdomain}/Update a Team
TeamsApiTeamsReadGET /teams/{subdomain}/Retrieve a Team
TemplatesApiTemplatesListGET /templates/Retrieve a list of Templates
TemplatesApiTemplatesReadGET /templates/{uuid}/Retrieve a Template
WebhooksApiWebhooksCreatePOST /webhooks/Create a Webhook
WebhooksApiWebhooksDeleteDELETE /webhooks/{uuid}/Delete a Webhook
WebhooksApiWebhooksListGET /webhooks/Retrieve a list of Webhooks
WebhooksApiWebhooksPartialUpdatePATCH /webhooks/{uuid}/Partially update a Webhook
WebhooksApiWebhooksReadGET /webhooks/{uuid}/Retrieve a Webhook
WebhooksApiWebhooksUpdatePUT /webhooks/{uuid}/Update a Webhook

Documentation for Models

Documentation for Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

Official C# client for SignRequest.com

Topics

Resources

Stars

5 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages