{"openapi":"3.1.0","info":{"title":"Clicksign (BYOK) API","version":"0.1.0","description":"Clicksign (BYOK) lets an AI assistant read your own Clicksign data through the Clicksign API with a key you supply (Clicksign access token (production)). Read-only: 6 tools (list_envelopes, get_envelope, list_envelope_documents, list_templates, list_folders, get_folder). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-clicksign.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-clicksign/docs"},"termsOfService":"https://connectorbay.com/byok-clicksign/terms"},"servers":[{"url":"https://byok-clicksign.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-clicksign/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_envelopes":{"post":{"operationId":"list_envelopes","summary":"List signature envelopes with name, status (draft, running, closed, canceled), deadline, language, auto-close and remind","description":"List signature envelopes with name, status (draft, running, closed, canceled), deadline, language, auto-close and reminder settings and dates. Signers and files are not included. Production environment only (app.clicksign.com). Use for \"Which Clicksign envelopes are still running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["draft","running","closed","canceled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only envelopes with this status.","title":"Status"},"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Exact envelope name to look for.","title":"Name"},"sort":{"anyOf":[{"enum":["name","-name"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by name: 'name' ascending or '-name' descending.","title":"Sort"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (default 25).","title":"Page Size"},"page_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_envelopesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_envelope":{"post":{"operationId":"get_envelope","summary":"Get one envelope: name, status, deadline, language, rubric, reminder and refusal settings and dates. Use for \"What is th","description":"Get one envelope: name, status, deadline, language, rubric, reminder and refusal settings and dates. Use for \"What is the status of Clicksign envelope 1108816e-a8da-41ed-b9e9-8d5111eb1f0d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope ID (UUID) from list_envelopes.","maxLength":200,"title":"Envelope Id","type":"string"}},"required":["envelope_id"],"title":"get_envelopeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_envelope_documents":{"post":{"operationId":"list_envelope_documents","summary":"List the documents attached to one envelope: file name, status, template flag and dates. File download links are not ret","description":"List the documents attached to one envelope: file name, status, template flag and dates. File download links are not returned. Use for \"Which documents are in Clicksign envelope 1108816e-a8da-41ed-b9e9-8d5111eb1f0d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"envelope_id":{"description":"Envelope ID (UUID) from list_envelopes.","maxLength":200,"title":"Envelope Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (default 25).","title":"Page Size"},"page_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"required":["envelope_id"],"title":"list_envelope_documentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_templates":{"post":{"operationId":"list_templates","summary":"List the document templates (models) of the account with name, colour and dates. Template file links are not returned. U","description":"List the document templates (models) of the account with name, colour and dates. Template file links are not returned. Use for \"Which document templates do we have in Clicksign\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (default 25).","title":"Page Size"},"page_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_folders":{"post":{"operationId":"list_folders","summary":"List the folders of the account with name, path, whether it is in the root and dates. Use for \"What folders exist in our","description":"List the folders of the account with name, path, whether it is in the root and dates. Use for \"What folders exist in our Clicksign account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"in_root":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only root level folders.","title":"In Root"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Items per page (default 25).","title":"Page Size"},"page_number":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_foldersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_folder":{"post":{"operationId":"get_folder","summary":"Get one folder by ID: name, path, root flag and dates. Use for \"Show Clicksign folder da1bd331-93f2-4943-b239-3f3fe48685","description":"Get one folder by ID: name, path, root flag and dates. Use for \"Show Clicksign folder da1bd331-93f2-4943-b239-3f3fe486852b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder ID (UUID) from list_folders.","maxLength":200,"title":"Folder Id","type":"string"}},"required":["folder_id"],"title":"get_folderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}