3460 строки
108 KiB
JSON
3460 строки
108 KiB
JSON
{
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"contact": {
|
||
"email": "integrations@getaccept.com",
|
||
"name": "GetAccept API Team",
|
||
"url": "https://app.getaccept.com/api"
|
||
},
|
||
"description": "GetAccept provides a sales enablement platform for sales to design, send, promote, track, and e-sign sales documents, leveraging sales collateral, contract management, proposals, and electronic signatures in one place.",
|
||
"termsOfService": "https://www.getaccept.com/terms.html",
|
||
"title": "GetAccept",
|
||
"version": "1.6"
|
||
},
|
||
"host": "api.getaccept.com",
|
||
"basePath": "/v1",
|
||
"schemes": [
|
||
"https"
|
||
],
|
||
"paths": {
|
||
"/attachments": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"attachments": {
|
||
"items": {
|
||
"properties": {
|
||
"attachment_id": {
|
||
"type": "string"
|
||
},
|
||
"attachment_title": {
|
||
"type": "string"
|
||
},
|
||
"attachment_type": {
|
||
"type": "string"
|
||
},
|
||
"attachment_url": {
|
||
"type": "string"
|
||
},
|
||
"library": {
|
||
"type": "boolean"
|
||
},
|
||
"published": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Attachments"
|
||
],
|
||
"description": "Receive a list of available attachments. You can add new attachments in GetAccept using a new document.",
|
||
"operationId": "ListAttachments",
|
||
"summary": "List attachments"
|
||
}
|
||
},
|
||
"/auth": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing authentication credentials",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"description": "Authentication model",
|
||
"properties": {
|
||
"client_id": {
|
||
"default": "",
|
||
"description": "The client id of your app if you received one from our API team",
|
||
"type": "string"
|
||
},
|
||
"email": {
|
||
"description": "This is the email of the user in GetAccept",
|
||
"format": "email",
|
||
"type": "string"
|
||
},
|
||
"entity_id": {
|
||
"default": "",
|
||
"description": "This specifies what entity to select if multiple entities are available for a user. If no value is specified the default entity will be selected.",
|
||
"type": "string"
|
||
},
|
||
"password": {
|
||
"description": "This is the password of the user in GetAccept",
|
||
"format": "password",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"email",
|
||
"password"
|
||
],
|
||
"type": "object",
|
||
"x-examples": {
|
||
"Example": {
|
||
"email": "user@example.com",
|
||
"password": "mysecret"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"access_token": {
|
||
"description": "Token to be used in consequtive requests using bearer header",
|
||
"type": "string"
|
||
},
|
||
"expires_in": {
|
||
"description": "Seconds until the access token expires",
|
||
"format": "int64",
|
||
"minimum": 0,
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"security": [],
|
||
"tags": [
|
||
"Authentication"
|
||
],
|
||
"description": "Token based authentication is recommended for server-based access or access from clients where OAuth is not suitable. Access tokens has to be requested using an administrators login credentials.\nRequests should include the header Content-Type with value application/json",
|
||
"operationId": "Authenticate",
|
||
"summary": "Authentication by token",
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/contacts": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Contacts"
|
||
],
|
||
"description": "Receive a list of available contact for the current entity.\nAll contacts added as a recipient are saved as a contact and is available for later use on that entity.",
|
||
"operationId": "ListContacts",
|
||
"summary": "List contacts"
|
||
},
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing contact information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"company_name": {
|
||
"description": "Associated company name",
|
||
"type": "string"
|
||
},
|
||
"company_number": {
|
||
"description": "Associated company number",
|
||
"type": "string"
|
||
},
|
||
"email": {
|
||
"description": "Email address of the contact",
|
||
"type": "string"
|
||
},
|
||
"first_name": {
|
||
"description": "First name of the contact",
|
||
"type": "string"
|
||
},
|
||
"fullname": {
|
||
"description": "Use to specify full name instead of first/last name",
|
||
"type": "string"
|
||
},
|
||
"last_name": {
|
||
"description": "Last name of the contact",
|
||
"type": "string"
|
||
},
|
||
"mobile": {
|
||
"description": "Mobile number in international format",
|
||
"type": "string"
|
||
},
|
||
"note": {
|
||
"description": "Optional internal note for contact",
|
||
"type": "string"
|
||
},
|
||
"phone": {
|
||
"description": "Phone number in international format",
|
||
"type": "string"
|
||
},
|
||
"title": {
|
||
"description": "The title of the contact, ex. CEO, Sales manager",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"contact_id": {
|
||
"description": "ID of the created contact",
|
||
"example": "abc58129f",
|
||
"type": "string",
|
||
"x-ms-summary": "Contact ID"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Contacts"
|
||
],
|
||
"description": "This will create a new contact in the database for the current entity",
|
||
"operationId": "CreateContact",
|
||
"summary": "Create contact",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
},
|
||
"/documents": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Filter list on status",
|
||
"enum": [
|
||
"draft",
|
||
"sent",
|
||
"viewed",
|
||
"reviewed",
|
||
"signed",
|
||
"rejected",
|
||
"recalled"
|
||
],
|
||
"in": "query",
|
||
"name": "filter",
|
||
"type": "string",
|
||
"x-ms-summary": "Filter list on status"
|
||
},
|
||
{
|
||
"description": "How to sort results",
|
||
"enum": [
|
||
"name",
|
||
"value",
|
||
"created",
|
||
"recipient",
|
||
"status",
|
||
"owner"
|
||
],
|
||
"in": "query",
|
||
"name": "sort_by",
|
||
"type": "string",
|
||
"x-ms-summary": "How to sort results"
|
||
},
|
||
{
|
||
"description": "Sort order of results",
|
||
"enum": [
|
||
"asc",
|
||
"desc"
|
||
],
|
||
"in": "query",
|
||
"name": "sort_order",
|
||
"type": "string",
|
||
"x-ms-summary": "Sort order of results"
|
||
},
|
||
{
|
||
"description": "Include documents from team members",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"in": "query",
|
||
"name": "showteam",
|
||
"type": "boolean",
|
||
"x-ms-summary": "Include documents from team members"
|
||
},
|
||
{
|
||
"description": "Include all documents from entity",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"in": "query",
|
||
"name": "showall",
|
||
"type": "boolean",
|
||
"x-ms-summary": "Include all documents from entity"
|
||
},
|
||
{
|
||
"description": "An external ID is a custom field which can contain a unique record identifier from a system outside of GetAccept",
|
||
"in": "query",
|
||
"name": "external_id",
|
||
"type": "string",
|
||
"x-ms-summary": "External ID"
|
||
},
|
||
{
|
||
"description": "Start list from record x until limit",
|
||
"in": "query",
|
||
"name": "offset",
|
||
"type": "number",
|
||
"x-ms-summary": "Offset"
|
||
},
|
||
{
|
||
"description": "Number of records to list",
|
||
"in": "query",
|
||
"name": "limit",
|
||
"type": "number",
|
||
"x-ms-summary": "Limit"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Documents"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "Get a list of available documents",
|
||
"operationId": "ListDocuments",
|
||
"summary": "List documents"
|
||
},
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing document information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"attachments": {
|
||
"description": "Attachments",
|
||
"items": {
|
||
"properties": {
|
||
"id": {
|
||
"description": "Attachment ID received from list or after upload",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListAttachments",
|
||
"value-collection": "attachments",
|
||
"value-path": "attachment_id",
|
||
"value-title": "attachment_title"
|
||
},
|
||
"x-ms-summary": "ID"
|
||
},
|
||
"require_view": {
|
||
"description": "Require that recipient view the attachment",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Require view",
|
||
"x-nullable": true
|
||
},
|
||
"type": {
|
||
"description": "file or external where file is an uploaded file and external is a link to an external file",
|
||
"enum": [
|
||
"file",
|
||
"external"
|
||
],
|
||
"type": "string",
|
||
"x-ms-summary": "Type"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array",
|
||
"x-ms-summary": "Attachment"
|
||
},
|
||
"custom_fields": {
|
||
"description": "Custom field",
|
||
"items": {
|
||
"properties": {
|
||
"id": {
|
||
"description": "ID of custom template field",
|
||
"type": "string",
|
||
"x-ms-summary": "Field ID"
|
||
},
|
||
"name": {
|
||
"description": "Name of custom template field",
|
||
"type": "string",
|
||
"x-ms-summary": "Field Name"
|
||
},
|
||
"value": {
|
||
"description": "Value of custom template field",
|
||
"type": "string",
|
||
"x-ms-summary": "Field Value"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array",
|
||
"x-ms-summary": "Custom"
|
||
},
|
||
"expiration_date": {
|
||
"description": "Date and time when the document should expire",
|
||
"format": "date-time",
|
||
"type": "string",
|
||
"x-ms-summary": "Expiration date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"external_id": {
|
||
"description": "External system ID for identification",
|
||
"type": "string",
|
||
"x-ms-summary": "External ID"
|
||
},
|
||
"file_content": {
|
||
"description": "Base64 encoded file content",
|
||
"type": "string",
|
||
"x-ms-summary": "File content"
|
||
},
|
||
"file_ids": {
|
||
"description": "Comma-separated, unique file-ids received when uploading files",
|
||
"type": "string",
|
||
"x-ms-summary": "File IDs"
|
||
},
|
||
"file_url": {
|
||
"description": "Url to document file. Documents must be public available for download",
|
||
"type": "string",
|
||
"x-ms-summary": "File URL"
|
||
},
|
||
"is_automatic_sending": {
|
||
"description": "If the document should be sent after creation",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Send automatically",
|
||
"x-ms-visibility": "important",
|
||
"x-nullable": true
|
||
},
|
||
"is_reminder_sending": {
|
||
"description": "Should automatic reminders be sent",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Send reminders",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"is_scheduled_sending": {
|
||
"description": "Should the sending be scheduled for sending in the future",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Schedule sending",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"is_signing": {
|
||
"description": "Should the document be sent for signing",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Sign document",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"is_signing_biometric": {
|
||
"description": "Use handwritten signature",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Handwritten signature",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"is_signing_forward": {
|
||
"description": "Should recipients be able to transfer signature rights",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Allow signature transfer",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"is_signing_initials": {
|
||
"description": "Sign document using recipient initials",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Sign with initials",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"is_sms_sending": {
|
||
"description": "Should the document be sent to recipient mobile by text",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Send SMS",
|
||
"x-nullable": true
|
||
},
|
||
"name": {
|
||
"description": "Enter a name of the document",
|
||
"type": "string",
|
||
"x-ms-summary": "Document name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"recipients": {
|
||
"items": {
|
||
"properties": {
|
||
"company_name": {
|
||
"description": "Company name of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Company name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"company_number": {
|
||
"description": "Company number of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Company number",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"email": {
|
||
"description": "Email address of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Email",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"first_name": {
|
||
"description": "Recipient first name",
|
||
"type": "string",
|
||
"x-ms-summary": "First name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"last_name": {
|
||
"description": "Last name of recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Last name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"mobile": {
|
||
"description": "Mobile phone in international format",
|
||
"type": "string",
|
||
"x-ms-summary": "Mobile"
|
||
},
|
||
"note": {
|
||
"description": "Additional note for a recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Note",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"order_num": {
|
||
"description": "If signing order is enabled",
|
||
"example": 1,
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"x-ms-summary": "Signing order",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"role": {
|
||
"description": "The kind of recipient in the document",
|
||
"enum": [
|
||
"signer",
|
||
"approver",
|
||
"cc"
|
||
],
|
||
"type": "string",
|
||
"x-ms-summary": "Recipient type",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"role_name": {
|
||
"description": "The name of the role in a template",
|
||
"type": "string",
|
||
"x-ms-summary": "Template role",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"verify_eid": {
|
||
"description": "Verify using EID",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Verify EID",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"verify_eid_type": {
|
||
"description": "EID type to be used for personal verification",
|
||
"type": "string",
|
||
"x-ms-summary": "EID type",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"verify_qna": {
|
||
"description": "Should a question be asked",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Enable question",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"verify_qna_answer": {
|
||
"description": "The answer to question",
|
||
"example": "123456789",
|
||
"type": "string",
|
||
"x-ms-summary": "Verification answer",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"verify_qna_open": {
|
||
"description": "Should question be asked before opening document",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Question on open",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"verify_qna_question": {
|
||
"description": "Question to ask for verification",
|
||
"example": "Enter your SSN",
|
||
"type": "string",
|
||
"x-ms-summary": "Verification question",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"verify_qna_sign": {
|
||
"description": "Should a question be asked before signing",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Sign question",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"verify_sms": {
|
||
"description": "Verify recipient by SMS",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Verify SMS",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
},
|
||
"verify_sms_open": {
|
||
"description": "Verify SMS on open",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Verify SMS on open",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"verify_sms_sign": {
|
||
"description": "Should a SMS verify the recipient before signing",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Verify by SMS",
|
||
"x-ms-visibility": "advanced",
|
||
"x-nullable": true
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array",
|
||
"x-ms-summary": "Recipient"
|
||
},
|
||
"scheduled_sending_time": {
|
||
"description": "Date and time when the document should be sent out",
|
||
"format": "date-time",
|
||
"type": "string",
|
||
"x-ms-summary": "Schedule send date",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"sender_email": {
|
||
"description": "Send from other email than authenticated user",
|
||
"type": "string",
|
||
"x-ms-summary": "Sender email override",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"sender_id": {
|
||
"description": "Send from other user than authenticated",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListUsers",
|
||
"value-collection": "users",
|
||
"value-path": "user_id",
|
||
"value-title": "email"
|
||
},
|
||
"x-ms-summary": "Sender user override",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"template_id": {
|
||
"description": "Select a template to use for the sending",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListTemplates",
|
||
"value-collection": "templates",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Template ID",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"type": {
|
||
"default": "sales",
|
||
"description": "Set the type/category of the document",
|
||
"enum": [
|
||
"sales",
|
||
"introduction",
|
||
"hr",
|
||
"other"
|
||
],
|
||
"example": "sales",
|
||
"type": "string",
|
||
"x-ms-summary": "Document type",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"value": {
|
||
"description": "Value of deal or document",
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"x-ms-summary": "Document value",
|
||
"x-ms-visibility": "important",
|
||
"x-nullable": true
|
||
},
|
||
"video_id": {
|
||
"description": "Select a video to use for the sending",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListVideos",
|
||
"value-collection": "videos",
|
||
"value-path": "video_id",
|
||
"value-title": "video_title"
|
||
},
|
||
"x-ms-summary": "Video ID",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"required": [
|
||
"name"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Document"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "You must create a document to be able to send it to a recipient. When creating a document you can refer to previously uploaded files with file_id or you can choose to create a document and upload the files in on API post. You can only upload ONE file when including a file in the create document POST.\n\nUse either file_ids parameter to use existing uploaded file(s), file_content to send the document as base64 encoded string or do a multipart post with file parameter.\n\nAll recipients must have either a valid e-mail or a mobile number.\n\nAll events are recorded using requestor IP address. You can override this using header CLIENT_IP containing the end-users public IP address.",
|
||
"operationId": "CreateDocument",
|
||
"summary": "Create and send document or template"
|
||
}
|
||
},
|
||
"/documents/{documentId}": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Document ID",
|
||
"in": "path",
|
||
"name": "documentId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListDocuments",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Document ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Document"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Access denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "Get document details by specifying a document id.",
|
||
"operationId": "GetDocumentDetails",
|
||
"summary": "Get document details"
|
||
}
|
||
},
|
||
"/documents/{documentId}/download": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json",
|
||
"application/pdf"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Document ID",
|
||
"in": "path",
|
||
"name": "documentId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Document ID",
|
||
"x-ms-url-encoding": "single"
|
||
},
|
||
{
|
||
"default": "true",
|
||
"description": "Return the binary file directly",
|
||
"enum": [
|
||
"true",
|
||
"false"
|
||
],
|
||
"in": "query",
|
||
"name": "direct",
|
||
"type": "string",
|
||
"x-ms-summary": "Return the binary file directly"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"headers": {
|
||
"Content-Disposition": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"schema": {
|
||
"properties": {
|
||
"document_url": {
|
||
"type": "string"
|
||
},
|
||
"file": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "Document file can always be downloaded but most likely you want to download it when it has status Signed. \n\nYou can select to receive a download-url or get the binary file.\n\nThe download URL is accessable 10 minutes after a request has been made.",
|
||
"operationId": "DownloadDocument",
|
||
"summary": "Download document",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
},
|
||
"/documents/{documentId}/fields": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Document ID",
|
||
"in": "path",
|
||
"name": "documentId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Document ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Fields"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "Get a list of fields for a document or template. Can be used both before and after a document has been signed.",
|
||
"operationId": "ListDocumentFields",
|
||
"summary": "Get document fields"
|
||
}
|
||
},
|
||
"/documents/{documentId}/recipients": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Document ID",
|
||
"in": "path",
|
||
"name": "documentId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListDocuments",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Document ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Recipients"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "Get a list of recipients for a specific document.",
|
||
"operationId": "ListRecipients",
|
||
"summary": "Get document recipients"
|
||
}
|
||
},
|
||
"/documents/{documentId}/seal": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Document ID",
|
||
"in": "path",
|
||
"name": "documentId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListDocuments",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Document ID",
|
||
"x-ms-url-encoding": "single"
|
||
},
|
||
{
|
||
"description": "An optional JSON object containing seal information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"schema": {
|
||
"properties": {
|
||
"sender_email": {
|
||
"description": "Use this to specify the sender user/owner by email address to be used for self-signing the document.",
|
||
"type": "string"
|
||
},
|
||
"sender_id": {
|
||
"description": "Use this to specify the sender user/owner by id to be used for self-signing the document.",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListUsers",
|
||
"value-collection": "users",
|
||
"value-path": "user_id",
|
||
"value-title": "name"
|
||
}
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK"
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "If you prefer to send the document manually you can use this method to seal the document. Do not use this method if you send the document automatically or if you use the send document method above.\n\nThis API call triggers the document seal action and can only be performed on documents with document_status = draft. The method will return individual access/signing links for each recipient.\n\nIf document was created using self-sign option it will also be self-signed by the authenticated or specified user before sealing.",
|
||
"operationId": "SealDocument",
|
||
"summary": "Seal document",
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/documents/{documentId}/send": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Document ID",
|
||
"in": "path",
|
||
"name": "documentId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListDocuments",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Document ID",
|
||
"x-ms-url-encoding": "single"
|
||
},
|
||
{
|
||
"description": "An optional JSON object containing sending information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"schema": {
|
||
"properties": {
|
||
"sender_email": {
|
||
"description": "Use this to specify the sender user/owner by email address to be used for self-signing the document.",
|
||
"format": "email",
|
||
"type": "string"
|
||
},
|
||
"sender_id": {
|
||
"description": "Use this to specify the sender user/owner by id to be used for self-signing the document.",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListUsers",
|
||
"value-collection": "users",
|
||
"value-path": "user_id",
|
||
"value-title": "name"
|
||
}
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Document"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "When you send a document via GetAccept, we deliver an email to all recipients, each containing a unique, secured link. This API call triggers the document send action and can only be performed on documents with document_status = draft. The document will be sent to recipients you provided when it was created.\n\nIf document was created using self-sign option it will also be self-signed by the authenticated or specified user before sending.",
|
||
"operationId": "SendDocument",
|
||
"summary": "Send existing document",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"/refresh": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"access_token": {
|
||
"type": "string"
|
||
},
|
||
"expires_in": {
|
||
"format": "int64",
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Authentication"
|
||
],
|
||
"description": "You can request a refreshed of the access token before the original token has expired.",
|
||
"operationId": "RefreshToken",
|
||
"summary": "Refresh an access token",
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/subscriptions": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing subscription information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"host": {
|
||
"description": "The host name to send the post to",
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"event": {
|
||
"description": "Event trigger",
|
||
"enum": [
|
||
"document.created",
|
||
"document.sent",
|
||
"document.viewed",
|
||
"document.reviewed",
|
||
"document.signed",
|
||
"document.approved",
|
||
"document.expired",
|
||
"document.rejected",
|
||
"document.downloaded",
|
||
"document.printed",
|
||
"document.forwarded",
|
||
"document.partially_signed",
|
||
"document.commented",
|
||
"document.hardbounced",
|
||
"document.imported"
|
||
],
|
||
"example": "document.signed",
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListSubscriptionEvents",
|
||
"value-path": "value",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Select event",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"global": {
|
||
"default": true,
|
||
"description": "If the webhook should catch events for all entity users.",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "All entity users",
|
||
"x-nullable": true
|
||
},
|
||
"notification_email": {
|
||
"description": "If the event fails, send a notification to this email instead of the sender",
|
||
"example": "hostmaster@example.com",
|
||
"type": "string",
|
||
"x-ms-summary": "Error email",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"payload": {
|
||
"description": "Additional payload data to post",
|
||
"type": "string",
|
||
"x-ms-summary": "Payload",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"target_url": {
|
||
"description": "The URL to post payload to on event",
|
||
"example": "https://abc.x.pipedream.net/",
|
||
"type": "string",
|
||
"x-ms-notification-url": true,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"required": [
|
||
"event",
|
||
"target_url"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Subscription"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Subscriptions"
|
||
],
|
||
"description": "This call will create a new subscription.\nThe response will be wrapped in an array even for single object according to REST hook standards.\n\n>Events\n * `document.created` - Document is created\n * `document.sent` - Document is sent\n * `document.viewed` - Document is sent\n * `document.signed` - Document is signed\n * `document.approved` - Document is approved\n * `document.expired` - Document has expired\n * `document.rejected` - Document is rejected\n * `document.downloaded` - Document is downloaded\n * `document.printed` - Document is printed\n * `document.forwarded` - Document is forwarded\n * `document.partially_signed` - Document has been partially signed\n * `document.commented` - Document is commented\n * `document.hardbounced` - Document is hardbounced\n * `document.imported` - Document is imported",
|
||
"operationId": "CreateSubscription",
|
||
"summary": "Subscribe to document events",
|
||
"x-ms-summary": "When a document status changes",
|
||
"x-ms-trigger": "single",
|
||
"x-ms-trigger-hint": "Trigger when a document status is changed",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"x-ms-notification-content": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Webhook"
|
||
}
|
||
}
|
||
},
|
||
"/subscriptions/events": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"items": {
|
||
"properties": {
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"value": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Subscriptions"
|
||
],
|
||
"description": "This call will return a list of available subscription events",
|
||
"operationId": "ListSubscriptionEvents",
|
||
"summary": "List available subscription events",
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/subscriptions/events/rejected": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing subscription information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"host": {
|
||
"description": "The host name to send the post to",
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"event": {
|
||
"default": "document.rejected",
|
||
"description": "Event trigger",
|
||
"type": "string",
|
||
"x-ms-summary": "Event trigger",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"global": {
|
||
"default": true,
|
||
"description": "If the webhook should catch events for all entity users.",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "All entity users",
|
||
"x-nullable": true
|
||
},
|
||
"notification_email": {
|
||
"description": "If the event fails, send a notification to this email instead of the sender",
|
||
"example": "hostmaster@example.com",
|
||
"type": "string",
|
||
"x-ms-summary": "Error email",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"payload": {
|
||
"description": "Additional payload data to post",
|
||
"type": "string",
|
||
"x-ms-summary": "Payload",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"target_url": {
|
||
"description": "The URL to post payload to on event",
|
||
"example": "https://abc.x.pipedream.net/",
|
||
"type": "string",
|
||
"x-ms-notification-url": true,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"required": [
|
||
"event",
|
||
"target_url"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Subscription"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Others"
|
||
],
|
||
"description": "Triggers when a document has been rejected by any of the recipients",
|
||
"operationId": "CreateRejectedSubscription",
|
||
"summary": "When a document has been rejected",
|
||
"x-ms-summary": "When a document has been rejected",
|
||
"x-ms-trigger": "single",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"x-ms-notification-content": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Webhook"
|
||
}
|
||
}
|
||
},
|
||
"/subscriptions/events/reviewed": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing subscription information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"host": {
|
||
"description": "The host name to send the post to",
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"event": {
|
||
"default": "document.reviewed",
|
||
"description": "Event trigger",
|
||
"type": "string",
|
||
"x-ms-summary": "Event trigger",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"global": {
|
||
"default": true,
|
||
"description": "If the webhook should catch events for all entity users.",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "All entity users",
|
||
"x-nullable": true
|
||
},
|
||
"notification_email": {
|
||
"description": "If the event fails, send a notification to this email instead of the sender",
|
||
"example": "hostmaster@example.com",
|
||
"type": "string",
|
||
"x-ms-summary": "Error email",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"payload": {
|
||
"description": "Additional payload data to post",
|
||
"type": "string",
|
||
"x-ms-summary": "Payload",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"target_url": {
|
||
"description": "The URL to post payload to on event",
|
||
"example": "https://abc.x.pipedream.net/",
|
||
"type": "string",
|
||
"x-ms-notification-url": true,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"required": [
|
||
"event",
|
||
"target_url"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Subscription"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Others"
|
||
],
|
||
"description": "Triggers when a document has been reviewed by any of the recipients",
|
||
"operationId": "CreateReviewedSubscription",
|
||
"summary": "When a document has been reviewed",
|
||
"x-ms-summary": "When a document has been reviewed",
|
||
"x-ms-trigger": "single",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"x-ms-notification-content": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Webhook"
|
||
}
|
||
}
|
||
},
|
||
"/subscriptions/events/signed": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing subscription information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"host": {
|
||
"description": "The host name to send the post to",
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"event": {
|
||
"default": "document.signed",
|
||
"description": "Event trigger",
|
||
"type": "string",
|
||
"x-ms-summary": "Event trigger",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"global": {
|
||
"default": true,
|
||
"description": "If the webhook should catch events for all entity users.",
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": true,
|
||
"type": "boolean",
|
||
"x-ms-summary": "All entity users",
|
||
"x-nullable": true
|
||
},
|
||
"notification_email": {
|
||
"description": "If the event fails, send a notification to this email instead of the sender",
|
||
"example": "hostmaster@example.com",
|
||
"type": "string",
|
||
"x-ms-summary": "Error email",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"payload": {
|
||
"description": "Additional payload data to post",
|
||
"type": "string",
|
||
"x-ms-summary": "Payload",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"target_url": {
|
||
"description": "The URL to post payload to on event",
|
||
"example": "https://abc.x.pipedream.net/",
|
||
"type": "string",
|
||
"x-ms-notification-url": true,
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"required": [
|
||
"event",
|
||
"target_url"
|
||
],
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Subscription"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Others"
|
||
],
|
||
"description": "Triggers when a document has been signed by all signing parties",
|
||
"operationId": "CreateSignedSubscription",
|
||
"summary": "When a document has been signed",
|
||
"x-ms-summary": "When a document has been signed",
|
||
"x-ms-trigger": "single",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"x-ms-notification-content": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Webhook"
|
||
}
|
||
}
|
||
},
|
||
"/subscriptions/{subscriptionId}": {
|
||
"delete": {
|
||
"parameters": [
|
||
{
|
||
"description": "Subscription ID",
|
||
"in": "path",
|
||
"name": "subscriptionId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Subscription ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "No Content"
|
||
}
|
||
},
|
||
"tags": [
|
||
"Subscriptions"
|
||
],
|
||
"description": "Delete a single subscription.",
|
||
"operationId": "DeleteSubscription",
|
||
"summary": "Delete subscription",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Subscription ID",
|
||
"in": "path",
|
||
"name": "subscriptionId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Subscription ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Subscription"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Subscriptions"
|
||
],
|
||
"description": "This call will return details of a single subscription",
|
||
"operationId": "GetSubscriptionDetails",
|
||
"summary": "Get subscription details",
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
},
|
||
"/templates": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"default": "true",
|
||
"description": "Show all templates for entity",
|
||
"in": "query",
|
||
"name": "showall",
|
||
"type": "string",
|
||
"x-ms-summary": "Show all"
|
||
},
|
||
{
|
||
"description": "Show templates in a specific folder",
|
||
"in": "query",
|
||
"name": "folder_id",
|
||
"type": "string",
|
||
"x-ms-summary": "Folder ID"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"templates": {
|
||
"items": {
|
||
"properties": {
|
||
"tags": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"external_editor_type": {
|
||
"type": "string"
|
||
},
|
||
"field_count": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"is_editable": {
|
||
"type": "boolean"
|
||
},
|
||
"is_private": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"page_count": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"role_count": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"sender_name": {
|
||
"type": "string"
|
||
},
|
||
"sender_thumb_url": {
|
||
"type": "string"
|
||
},
|
||
"thumb_url": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"type": "string"
|
||
},
|
||
"video_id": {
|
||
"type": "string"
|
||
},
|
||
"video_thumb_url": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Templates"
|
||
],
|
||
"description": "Receive a list of available document templates. You can add new templates under the Templates-section in GetAccept.",
|
||
"operationId": "ListTemplates",
|
||
"summary": "List templates",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
},
|
||
"/templates/{templateId}/fields": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Template ID",
|
||
"in": "path",
|
||
"name": "templateId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListTemplates",
|
||
"value-collection": "templates",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Template ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Fields"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Templates"
|
||
],
|
||
"description": "Receive a list of fields for a specific template.",
|
||
"operationId": "ListFields",
|
||
"summary": "Get template fields"
|
||
}
|
||
},
|
||
"/templates/{templateId}/roles": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Template ID",
|
||
"in": "path",
|
||
"name": "templateId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListTemplates",
|
||
"value-collection": "templates",
|
||
"value-path": "id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "Template ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"roles": {
|
||
"items": {
|
||
"properties": {
|
||
"email": {
|
||
"type": "string"
|
||
},
|
||
"first_name": {
|
||
"type": "string"
|
||
},
|
||
"last_name": {
|
||
"type": "string"
|
||
},
|
||
"mobile": {
|
||
"type": "string"
|
||
},
|
||
"role": {
|
||
"type": "string"
|
||
},
|
||
"role_id": {
|
||
"type": "string"
|
||
},
|
||
"role_name": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Templates"
|
||
],
|
||
"description": "Receive a list of roles for a specific template.",
|
||
"operationId": "ListRoles",
|
||
"summary": "Get template roles"
|
||
}
|
||
},
|
||
"/upload": {
|
||
"post": {
|
||
"consumes": [
|
||
"multipart/form-data",
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Binary File",
|
||
"format": "binary",
|
||
"in": "formData",
|
||
"name": "file",
|
||
"type": "string",
|
||
"x-ms-summary": "Binary File",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
{
|
||
"description": "Filename of the document, with the extension. This will be helpful for converting different file-types.",
|
||
"in": "formData",
|
||
"name": "file_name",
|
||
"type": "string",
|
||
"x-ms-summary": "File name"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"file_id": {
|
||
"description": "ID of the uploaded file to be used in file_ids when creating a document",
|
||
"type": "string"
|
||
},
|
||
"file_status": {
|
||
"description": "Status of the uploaded file",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Documents"
|
||
],
|
||
"description": "You can upload one file at a time and get a file id. The file id is used to connect a file with a GetAccept document which is sent to recipients. If you want to upload mutliple files you run multiple POST. We only accept files up to 10 MB as default. Uploaded file need to be imported/added to a document within 48 hours after uploading.\n\nWe recommended you to upload PDF files in order to guarantee the same look when sent. Other file types can be converted, such as:\n\nMirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx\nMac: numbers, key\nImages: jpg, jpeg, png\nOther: html, tex, csv",
|
||
"operationId": "UploadDocument",
|
||
"summary": "Upload a document file",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
},
|
||
"/upload/attachment": {
|
||
"post": {
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Binary File",
|
||
"format": "binary",
|
||
"in": "formData",
|
||
"name": "file",
|
||
"type": "string",
|
||
"x-ms-summary": "Binary File"
|
||
},
|
||
{
|
||
"description": "Filename of the document, with the extension. This will be helpful for converting different file-types.",
|
||
"in": "formData",
|
||
"name": "file_name",
|
||
"type": "string",
|
||
"x-ms-summary": "File name"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"filename": {
|
||
"description": "File name of the attachment",
|
||
"type": "string",
|
||
"x-ms-summary": "File name"
|
||
},
|
||
"id": {
|
||
"description": "ID of the uploaded attachment to be used in attachment_id when creating a document",
|
||
"type": "string",
|
||
"x-ms-summary": "Attachment ID"
|
||
},
|
||
"title": {
|
||
"description": "Title of the attachment",
|
||
"type": "string",
|
||
"x-ms-summary": "Attachment title"
|
||
},
|
||
"type": {
|
||
"description": "Type of the attachment",
|
||
"type": "string",
|
||
"x-ms-summary": "Attachment type"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Attachments"
|
||
],
|
||
"description": "You can upload attachment files to include with documents you send.\nSuccessful request will return the attachment_id. Use attachment_id to assign an attachment to a document.",
|
||
"operationId": "UploadAttachment",
|
||
"summary": "Upload an attachment"
|
||
}
|
||
},
|
||
"/upload/video": {
|
||
"post": {
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "Binary File",
|
||
"format": "binary",
|
||
"in": "formData",
|
||
"name": "file",
|
||
"type": "string",
|
||
"x-ms-summary": "Binary File"
|
||
},
|
||
{
|
||
"description": "Filename of the video, with the extension. This will be helpful for converting different file-types.",
|
||
"in": "formData",
|
||
"name": "file_name",
|
||
"type": "string",
|
||
"x-ms-summary": "File name"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"file_status": {
|
||
"description": "Status of the video",
|
||
"type": "string",
|
||
"x-ms-summary": "File status"
|
||
},
|
||
"filename": {
|
||
"description": "File name of the video",
|
||
"type": "string",
|
||
"x-ms-summary": "File name"
|
||
},
|
||
"job_id": {
|
||
"description": "Id of the processing job converting and compressing the video. Poll for job status updates using /video/job/<ID>.",
|
||
"type": "string",
|
||
"x-ms-summary": "Job ID"
|
||
},
|
||
"video_id": {
|
||
"description": "ID of the uploaded video to be used in video_id when creating a document",
|
||
"type": "string",
|
||
"x-ms-summary": "Video ID"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Videos"
|
||
],
|
||
"description": "You can upload attachment files to include with documents you send.\nSuccessful request will return the attachment_id. Use attachment_id to assign an attachment to a document.",
|
||
"operationId": "UploadVideo",
|
||
"summary": "Upload a video"
|
||
}
|
||
},
|
||
"/users": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/Users"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Users"
|
||
],
|
||
"description": "Fetch a list of active users for the current authenticated entity",
|
||
"operationId": "ListUsers",
|
||
"summary": "List users"
|
||
},
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "A JSON object containing user information",
|
||
"in": "body",
|
||
"name": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"properties": {
|
||
"company_name": {
|
||
"description": "Associated company name",
|
||
"type": "string"
|
||
},
|
||
"company_number": {
|
||
"description": "Associated company number",
|
||
"type": "string"
|
||
},
|
||
"email": {
|
||
"description": "Email address of the contact",
|
||
"type": "string"
|
||
},
|
||
"first_name": {
|
||
"description": "First name of the contact",
|
||
"type": "string"
|
||
},
|
||
"fullname": {
|
||
"description": "Use to specify full name instead of first/last name",
|
||
"type": "string"
|
||
},
|
||
"last_name": {
|
||
"description": "Last name of the contact",
|
||
"type": "string"
|
||
},
|
||
"mobile": {
|
||
"description": "Mobile number in international format",
|
||
"type": "string"
|
||
},
|
||
"note": {
|
||
"description": "Optional internal note for contact",
|
||
"type": "string"
|
||
},
|
||
"phone": {
|
||
"description": "Phone number in international format",
|
||
"type": "string"
|
||
},
|
||
"title": {
|
||
"description": "The title of the contact, ex. CEO, Sales manager",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/User"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid data",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Users"
|
||
],
|
||
"description": "This will create a new contact in the database for the current entity",
|
||
"operationId": "CreateUser",
|
||
"summary": "Create user",
|
||
"x-ms-visibility": "important"
|
||
}
|
||
},
|
||
"/users/{userId}": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"description": "User ID",
|
||
"in": "path",
|
||
"name": "userId",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "ListUsers",
|
||
"value-collection": "users",
|
||
"value-path": "user_id",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-summary": "User ID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/User"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "The specified resource was not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Users"
|
||
],
|
||
"description": "This call will return details of a single user.\nReceive details and available entities of the current authenticated user using user-id *me*",
|
||
"operationId": "GetUserDetails",
|
||
"summary": "Get user details"
|
||
}
|
||
},
|
||
"/videos": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"properties": {
|
||
"videos": {
|
||
"items": {
|
||
"properties": {
|
||
"editable": {
|
||
"type": "boolean"
|
||
},
|
||
"published": {
|
||
"type": "boolean"
|
||
},
|
||
"saved": {
|
||
"type": "boolean"
|
||
},
|
||
"thumb_url": {
|
||
"type": "string"
|
||
},
|
||
"video_id": {
|
||
"type": "string"
|
||
},
|
||
"video_title": {
|
||
"type": "string"
|
||
},
|
||
"video_type": {
|
||
"type": "string"
|
||
},
|
||
"video_url": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"type": "object"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
"Videos"
|
||
],
|
||
"description": "Receive a list of available videos on the entity. You can add new videos in the mobile app or inside GetAccept.",
|
||
"operationId": "ListVideos",
|
||
"summary": "List videos"
|
||
}
|
||
}
|
||
},
|
||
"definitions": {
|
||
"Document": {
|
||
"description": "A document is one or multiple uploaded file(s) that is to be sent to one or many recipients created by a user.",
|
||
"properties": {
|
||
"tags": {
|
||
"type": "string",
|
||
"x-ms-summary": "Tags"
|
||
},
|
||
"auto_comment_email": {
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"auto_comment_text": {
|
||
"type": "string",
|
||
"x-ms-summary": "Automatic chat text",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"company_id": {
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"company_logo_url": {
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"company_name": {
|
||
"type": "string",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"company_number": {
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"created_at": {
|
||
"type": "string",
|
||
"x-ms-summary": "Created at",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"download_url": {
|
||
"type": "string",
|
||
"x-ms-summary": "Download URL"
|
||
},
|
||
"email_send_message": {
|
||
"type": "string",
|
||
"x-ms-summary": "Email message",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"email_send_subject": {
|
||
"type": "string",
|
||
"x-ms-summary": "Email Subject",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"email_send_template_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Email send template ID",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"entity_auto_comment_text": {
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"expiration_date": {
|
||
"type": "string",
|
||
"x-ms-summary": "Expiration date"
|
||
},
|
||
"external_client_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "External Client ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"external_editor_id": {
|
||
"type": "string",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"external_editor_type": {
|
||
"type": "string",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"external_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "External ID"
|
||
},
|
||
"field_count": {
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"x-ms-summary": "Field count",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"x-ms-summary": "ID",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"is_auto_comment": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Auto comment",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_auto_comment_email": {
|
||
"type": "boolean",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_identify_recipient": {
|
||
"type": "boolean",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_private": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Is private",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_reminder_sending": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Send reminders",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_scheduled_sending": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Scheduled sending",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_selfsign": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Is Self-signing",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_signed": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Is signed",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_signing": {
|
||
"type": "boolean",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_signing_biometric": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Handwritten signature",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_signing_forward": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Allow signature transfer",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_signing_initials": {
|
||
"type": "boolean",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"is_signing_order": {
|
||
"type": "boolean",
|
||
"x-ms-summary": "Signature order",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"is_video": {
|
||
"type": "boolean",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"x-ms-summary": "Name",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"parent_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Parent ID"
|
||
},
|
||
"preview_url": {
|
||
"type": "string",
|
||
"x-ms-summary": "Preview URL",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"recipients": {
|
||
"items": {
|
||
"$ref": "#/definitions/Recipient"
|
||
},
|
||
"type": "array"
|
||
},
|
||
"scheduled_sending_time": {
|
||
"type": "string",
|
||
"x-ms-summary": "Scheduled sending time",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"send_date": {
|
||
"type": "string",
|
||
"x-ms-summary": "Send date"
|
||
},
|
||
"sender_email": {
|
||
"type": "string",
|
||
"x-ms-summary": "Sender email"
|
||
},
|
||
"sender_name": {
|
||
"type": "string",
|
||
"x-ms-summary": "Sender name"
|
||
},
|
||
"sender_thumb_url": {
|
||
"type": "string",
|
||
"x-ms-summary": "Sender thumb URL",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"sign_date": {
|
||
"type": "string",
|
||
"x-ms-summary": "Sign date"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"x-ms-summary": "Status",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"thumb_url": {
|
||
"type": "string",
|
||
"x-ms-summary": "Thumb URL",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"type": {
|
||
"type": "string",
|
||
"x-ms-summary": "Type"
|
||
},
|
||
"unique_id": {
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"x-ms-summary": "Unique ID"
|
||
},
|
||
"user_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "User ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"value": {
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"x-ms-summary": "Value"
|
||
}
|
||
},
|
||
"title": "Document",
|
||
"type": "object",
|
||
"x-ms-summary": "Document"
|
||
},
|
||
"Documents": {
|
||
"description": "Document list",
|
||
"items": {
|
||
"properties": {
|
||
"tags": {
|
||
"type": "string"
|
||
},
|
||
"company_name": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"expiration_date": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"is_private": {
|
||
"type": "boolean"
|
||
},
|
||
"is_signing": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"sender_name": {
|
||
"type": "string"
|
||
},
|
||
"sender_thumb": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
},
|
||
"value": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"title": "Documents",
|
||
"type": "array",
|
||
"x-ms-summary": "Documents"
|
||
},
|
||
"Error": {
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"error": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"title": "Error",
|
||
"type": "object",
|
||
"x-ms-summary": "Error"
|
||
},
|
||
"Field": {
|
||
"description": "Field details",
|
||
"properties": {
|
||
"field_height": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"field_id": {
|
||
"type": "string"
|
||
},
|
||
"field_label": {
|
||
"type": "string"
|
||
},
|
||
"field_left": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"field_top": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"field_type": {
|
||
"type": "string"
|
||
},
|
||
"field_value": {
|
||
"type": "string"
|
||
},
|
||
"field_width": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
},
|
||
"is_collectable": {
|
||
"type": "boolean"
|
||
},
|
||
"is_editable": {
|
||
"type": "boolean"
|
||
},
|
||
"is_required": {
|
||
"type": "boolean"
|
||
},
|
||
"page_id": {
|
||
"type": "string"
|
||
},
|
||
"recipient_id": {
|
||
"type": "string"
|
||
},
|
||
"recipient_name": {
|
||
"type": "string"
|
||
},
|
||
"validation_regex": {
|
||
"type": "string"
|
||
},
|
||
"validation_warning": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"title": "Field",
|
||
"type": "object",
|
||
"x-ms-summary": "Field"
|
||
},
|
||
"Fields": {
|
||
"description": "Field list",
|
||
"properties": {
|
||
"fields": {
|
||
"items": {
|
||
"$ref": "#/definitions/Field"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"title": "Fields",
|
||
"type": "object",
|
||
"x-ms-summary": "Fields"
|
||
},
|
||
"Recipient": {
|
||
"description": "Every unique e-mail address (or mobile number) that is connected to a document is a recipient.",
|
||
"properties": {
|
||
"company_name": {
|
||
"description": "Company name of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Company name"
|
||
},
|
||
"company_number": {
|
||
"description": "Company number of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Company number"
|
||
},
|
||
"document_url": {
|
||
"description": "Unique URL for the recipient to view/sign",
|
||
"type": "string",
|
||
"x-ms-summary": "Document URL",
|
||
"x-ms-visibility": "important"
|
||
},
|
||
"email": {
|
||
"description": "Name of the created document",
|
||
"type": "string",
|
||
"x-ms-summary": "Recipient email"
|
||
},
|
||
"first_name": {
|
||
"description": "First name of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "First name"
|
||
},
|
||
"fullname": {
|
||
"description": "Full name of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Full name"
|
||
},
|
||
"gender": {
|
||
"description": "Gender of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Gender",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"id": {
|
||
"description": "ID of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "ID",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"last_name": {
|
||
"description": "Last name of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Last name"
|
||
},
|
||
"mobile": {
|
||
"description": "Mobile number of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Mobile"
|
||
},
|
||
"note": {
|
||
"description": "Note of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Note",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"order_num": {
|
||
"description": "Signing order of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Signing order num",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"role": {
|
||
"type": "string",
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"status": {
|
||
"description": "Status of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Status"
|
||
},
|
||
"thumb_url": {
|
||
"description": "Thumb URL of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Thumb URL"
|
||
},
|
||
"title": {
|
||
"description": "Title of the recipient",
|
||
"type": "string",
|
||
"x-ms-summary": "Title"
|
||
}
|
||
},
|
||
"title": "Recipient",
|
||
"type": "object",
|
||
"x-ms-summary": "Recipient"
|
||
},
|
||
"Recipients": {
|
||
"description": "Recipient list",
|
||
"properties": {
|
||
"recipients": {
|
||
"items": {
|
||
"$ref": "#/definitions/Recipient"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"title": "Recipients",
|
||
"type": "object",
|
||
"x-ms-summary": "Recipients"
|
||
},
|
||
"Subscription": {
|
||
"description": "Subscription details",
|
||
"properties": {
|
||
"host": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"event": {
|
||
"type": "string"
|
||
},
|
||
"global": {
|
||
"type": "boolean"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"notification_email": {
|
||
"type": "string"
|
||
},
|
||
"payload": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"format": "int32",
|
||
"type": "integer",
|
||
"x-nullable": true
|
||
},
|
||
"subscription_id": {
|
||
"type": "string"
|
||
},
|
||
"target_url": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"title": "Subscription",
|
||
"type": "object",
|
||
"x-ms-summary": "Subscription"
|
||
},
|
||
"User": {
|
||
"description": "A user is defined by it´s e-mail address and is connected to one or many entities.\n\n### User Roles\n\n#### Administrator:\n- View all documents\n- Edit all documents\n- Change entity settings, info and billing\n- Add new users to the entity\n- Assign entity roles\n\n#### Manager:\n- View team documents\n- Edit all documents\n- Add new users to the entity\n\n## Entity\nAn entity is the top node and all users and corresponding documents are connected to an entity. An entity is often the same as a company, a country or a department in a large organization.\n",
|
||
"properties": {
|
||
"app_mode": {
|
||
"type": "string",
|
||
"x-ms-summary": "App Mode"
|
||
},
|
||
"disallow_create": {
|
||
"type": "boolean"
|
||
},
|
||
"email": {
|
||
"description": "Email address of the user",
|
||
"type": "string",
|
||
"x-ms-summary": "Email"
|
||
},
|
||
"entity_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Entity ID"
|
||
},
|
||
"entity_name": {
|
||
"type": "string",
|
||
"x-ms-summary": "Entity Name"
|
||
},
|
||
"first_name": {
|
||
"description": "First name of the user",
|
||
"type": "string",
|
||
"x-ms-summary": "First name"
|
||
},
|
||
"id": {
|
||
"description": "ID of the user",
|
||
"type": "string",
|
||
"x-ms-summary": "ID"
|
||
},
|
||
"language": {
|
||
"type": "string",
|
||
"x-ms-summary": "Language"
|
||
},
|
||
"last_name": {
|
||
"description": "Last name of the user",
|
||
"type": "string",
|
||
"x-ms-summary": "Last name"
|
||
},
|
||
"mobile": {
|
||
"description": "Mobile number in international format",
|
||
"type": "string",
|
||
"x-ms-summary": "mobile"
|
||
},
|
||
"note": {
|
||
"description": "Optional internal note for user",
|
||
"type": "string",
|
||
"x-ms-summary": "Note"
|
||
},
|
||
"phone": {
|
||
"description": "Phone number in international format",
|
||
"type": "string",
|
||
"x-ms-summary": "Phone"
|
||
},
|
||
"role": {
|
||
"enum": [
|
||
"user",
|
||
"manager",
|
||
"admin"
|
||
],
|
||
"example": "user",
|
||
"type": "string",
|
||
"x-ms-summary": "Role"
|
||
},
|
||
"skip_invitation": {
|
||
"enum": [
|
||
true,
|
||
false
|
||
],
|
||
"example": false,
|
||
"type": "boolean",
|
||
"x-ms-summary": "Skip sending invitation",
|
||
"x-nullable": true
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"x-ms-summary": "Status"
|
||
},
|
||
"team_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Team ID"
|
||
},
|
||
"thumb_url": {
|
||
"type": "string",
|
||
"x-ms-summary": "Thumb URL"
|
||
},
|
||
"timezone": {
|
||
"type": "string",
|
||
"x-ms-summary": "Timezone"
|
||
},
|
||
"title": {
|
||
"description": "The title of the user, ex. CEO, Sales manager",
|
||
"type": "string",
|
||
"x-ms-summary": "Title"
|
||
}
|
||
},
|
||
"title": "User",
|
||
"type": "object",
|
||
"x-ms-summary": "User"
|
||
},
|
||
"Users": {
|
||
"description": "User list",
|
||
"properties": {
|
||
"users": {
|
||
"items": {
|
||
"properties": {
|
||
"email": {
|
||
"type": "string"
|
||
},
|
||
"first_name": {
|
||
"type": "string"
|
||
},
|
||
"last_login": {
|
||
"type": "string"
|
||
},
|
||
"last_name": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"role": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
},
|
||
"team_name": {
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"type": "array"
|
||
}
|
||
},
|
||
"title": "Users",
|
||
"type": "object",
|
||
"x-ms-summary": "Users"
|
||
},
|
||
"Webhook": {
|
||
"description": "Webhook payload",
|
||
"properties": {
|
||
"custom_fields": {
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
},
|
||
"type": "object"
|
||
},
|
||
"document": {
|
||
"$ref": "#/definitions/Document"
|
||
},
|
||
"entity": {
|
||
"properties": {
|
||
"custom_domain": {
|
||
"type": "string",
|
||
"x-ms-summary": "Entity custom domain",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"email_send_message": {
|
||
"type": "string",
|
||
"x-ms-summary": "Default email message",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"email_send_subject": {
|
||
"type": "string",
|
||
"x-ms-summary": "Default email subject",
|
||
"x-ms-visibility": "advanced"
|
||
},
|
||
"sub_domain": {
|
||
"type": "string",
|
||
"x-ms-summary": "Entity sub-domain",
|
||
"x-ms-visibility": "advanced"
|
||
}
|
||
},
|
||
"type": "object"
|
||
},
|
||
"event": {
|
||
"type": "string",
|
||
"x-ms-summary": "Event name"
|
||
},
|
||
"event_action": {
|
||
"type": "string",
|
||
"x-ms-summary": "Event action"
|
||
},
|
||
"event_type": {
|
||
"type": "string",
|
||
"x-ms-summary": "Event type"
|
||
},
|
||
"recipient": {
|
||
"$ref": "#/definitions/Recipient"
|
||
},
|
||
"subscription_id": {
|
||
"type": "string",
|
||
"x-ms-summary": "Subscription ID"
|
||
}
|
||
},
|
||
"title": "Webhook",
|
||
"type": "object",
|
||
"x-ms-summary": "Webhook"
|
||
}
|
||
},
|
||
"securityDefinitions": {
|
||
"Oauth2": {
|
||
"authorizationUrl": "https://app.getaccept.com/oauth2/authorize",
|
||
"description": "For testing purpose, use client_id **api** and client_secret **app**",
|
||
"flow": "accessCode",
|
||
"scopes": {
|
||
"basic": "Grants basic access to operations"
|
||
},
|
||
"tokenUrl": "https://app.getaccept.com/oauth2/token",
|
||
"type": "oauth2"
|
||
},
|
||
"Token": {
|
||
"description": "Enter your bearer token",
|
||
"in": "header",
|
||
"name": "Authorization",
|
||
"type": "apiKey"
|
||
}
|
||
},
|
||
"security": [
|
||
{
|
||
"Oauth2": [
|
||
"basic"
|
||
]
|
||
},
|
||
{
|
||
"Token": []
|
||
}
|
||
],
|
||
"tags": [
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#authentication"
|
||
},
|
||
"description": "Authentication with the GetAccept API can be made using JWT tokens (JSON Web Tokens) or OAuth 2.0 Authorization Framework http://oauth.net/2/ All requests must be made via HTTPS. All configuration URLs (webhooks, etc) should begin with https:// as well.",
|
||
"name": "Authentication"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#contacts"
|
||
},
|
||
"description": "Everything related to contacts",
|
||
"name": "Contacts"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#documents"
|
||
},
|
||
"description": "Everything related to documents",
|
||
"name": "Documents"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#subscriptions"
|
||
},
|
||
"description": "To simplify the process of checking a documents status and make it more efficient in an integrated application, you can enable API Webhooks. Enable webhooks as a user with administrator privileges in the Settings | Integration | Webhooks. We support multiple webhooks for one application. Events will be POSTed to your webhook URLs and should be handled by you. A POST must be answered and your endpoint will need to return a 2xx HTTP. Otherwise, the callback will be considered a failure and will be retried later. Retries will be made after 1, 12, 24, and 48 hours. The sender (or notification_email) will receive an email notification after a failed attempt.",
|
||
"name": "Subscriptions"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#templates"
|
||
},
|
||
"description": "GetAccept has extensive support for creating templates in different formats. You can use form fields to receive input data from a recipient or word files to merge custom data into a document.",
|
||
"name": "Templates"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#users"
|
||
},
|
||
"description": "General user methods for creating, listing of users, single user details and statistics and managing existing users.",
|
||
"name": "Users"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#attachments"
|
||
},
|
||
"description": "You can upload an attachment and reuse it in many documents.",
|
||
"name": "Attachments"
|
||
},
|
||
{
|
||
"externalDocs": {
|
||
"url": "https://app.getaccept.com/api/#video"
|
||
},
|
||
"description": "You can upload videos and reuse it in many documents.",
|
||
"name": "Videos"
|
||
},
|
||
{
|
||
"description": "Additional endpoints used in various integrations.",
|
||
"name": "Others"
|
||
}
|
||
],
|
||
"x-components": {
|
||
"responses": {
|
||
"AccessDenied": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"description": "Access denied"
|
||
},
|
||
"Invalid": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"description": "Invalid data"
|
||
},
|
||
"NotFound": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"description": "The specified resource was not found"
|
||
},
|
||
"Unauthorized": {
|
||
"content": {
|
||
"application/json": {
|
||
"schema": {
|
||
"$ref": "#/definitions/Error"
|
||
}
|
||
}
|
||
},
|
||
"description": "Unauthorized"
|
||
}
|
||
},
|
||
"headers": {
|
||
"X-Rate-Limit-Limit": {
|
||
"description": "The number of allowed requests in the current period",
|
||
"schema": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"X-Rate-Limit-Remaining": {
|
||
"description": "The number of remaining requests in the current period",
|
||
"schema": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"X-Rate-Limit-Reset": {
|
||
"description": "The number of seconds left in the current period",
|
||
"schema": {
|
||
"format": "int32",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"x-ms-connector-metadata": [
|
||
{
|
||
"propertyName": "Website",
|
||
"propertyValue": "https://www.getaccept.com"
|
||
},
|
||
{
|
||
"propertyName": "Privacy policy",
|
||
"propertyValue": "https://www.getaccept.com/privacy-policy"
|
||
},
|
||
{
|
||
"propertyName": "Categories",
|
||
"propertyValue": "Sales and CRM;Productivity"
|
||
}
|
||
]
|
||
} |