Welcome to the Anvil API! This is the same API that powers Anvil, giving you the ability to access all of the features available in the Anvil UI. Use this API to create, manage, and start workflows or simply generate completed PDFs with your own data.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14149649","collectionId":"ab65f25e-253c-4750-9e44-d4850e3daa5a","publishedId":"TVzSjcj6","public":true,"customColor":{"top-bar":"FBFBFC","right-sidebar":"2B2B47","highlight":"7AEFB2"},"publishDate":"2021-01-12T21:08:38.000Z"},"item":[{"name":"Etch E-Sign API","item":[{"name":"Create Etch Packet","event":[{"listen":"prerequest","script":{"id":"77e9cf79-f095-48f1-b640-8e72182dd0da","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"ed1e331a-0d47-464e-a4f0-b0392cec80bc","exec":[""],"type":"text/javascript"}}],"id":"57efbd2f-87e6-43ae-be5f-d4ce61ea9092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation (\n $name: String,\n $files: [EtchFile!],\n $isDraft: Boolean,\n $isTest: Boolean,\n $signatureEmailSubject: String,\n $signatureEmailBody: String,\n $signatureProvider: String,\n $signaturePageOptions: JSON,\n $signers: [JSON!],\n $data: JSON,\n) {\n createEtchPacket (\n name: $name,\n files: $files,\n isDraft: $isDraft,\n isTest: $isTest,\n signatureEmailSubject: $signatureEmailSubject,\n signatureEmailBody: $signatureEmailBody,\n signatureProvider: $signatureProvider,\n signaturePageOptions: $signaturePageOptions,\n signers: $signers,\n data: $data\n ) {\n eid\n name\n detailsURL\n documentGroup {\n eid\n status\n signers {\n eid\n name\n email\n status\n routingOrder\n }\n }\n }\n}","variables":"{\n \"name\": \"Important Packet of Forms\",\n \"isDraft\": false,\n \"isTest\": true,\n \"signatureEmailSubject\": \"Test Packet\",\n \"signatureEmailBody\": \"Please sign these forms as soon as possible. Thanks!\",\n \"signatureProvider\": \"etch\",\n \"signaturePageOptions\": {\n \"title\": \"Test Packet\",\n \"description\": \"Please soon as soon as posssible\",\n \"style\": {\n \"successColor\": \"#1985a1\",\n \"infoColor\": \"#46494c\"\n }\n },\n \"files\": [\n {\n \"id\": \"PDF_Template_IRS_W4\",\n \"castEid\": \"XnuTZKVZg1Mljsu999od\"\n }\n ],\n \"signers\": [\n {\n \"id\": \"signer1\",\n \"name\": \"Sally Signer\",\n \"email\": \"sally@example.com\",\n \"fields\": [\n {\n \"fileId\": \"PDF_Template_IRS_W4\",\n \"fieldId\": \"employeeSignature\"\n },\n {\n \"fileId\": \"PDF_Template_IRS_W4\",\n \"fieldId\": \"employeeSignatureDate\"\n }\n ],\n \"signerType\": \"embedded\",\n \"redirectURL\": \"https://www.useanvil.com/docs/api/e-signatures#redirecturl\",\n \"enableEmails\": [\"etchComplete\"]\n }\n ],\n \"data\": {\n \"payloads\": {\n \"PDF_Template_IRS_W4\": {\n \"textColor\": \"#0000CC\",\n \"data\": {\n \"name\": \"Sally Signer\",\n \"address\": {\n \"street1\": \"123 Main St #234\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94106\",\n \"country\": \"US\"\n },\n \"ssn\": \"456454567\",\n \"filingStatus\": \"Joint\",\n \"under17Cost\": 2000,\n \"otherDependentsCost\": 0,\n \"totalDependentsCost\": 2000,\n \"otherIncome\": 0,\n \"otherDeductions\": 0,\n \"extraWithholding\": 0,\n \"employerName\": \"Awesome Co Inc\",\n \"firstDateEmployment\": \"2021-01-12\",\n \"employerEin\": \"897654321\",\n \"headOfHousehold\": true,\n \"employerAddress\": {\n \"street1\": \"555 Market St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\"\n }\n }\n }\n }\n }\n}"}},"url":"https://graphql.useanvil.com","description":"Creates an Etch Signature Packet and optionally sends it to the first signer.
\n","urlObject":{"protocol":"https","host":["graphql","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57efbd2f-87e6-43ae-be5f-d4ce61ea9092"},{"name":"Send Etch Packet","id":"fc3512d0-8dd6-4862-b720-b52419c1493c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation ($etchPacketEid: String!) {\n sendEtchPacket (eid: $etchPacketEid) {\n eid\n name\n detailsURL\n documentGroup {\n eid\n status\n signers {\n eid\n name\n email\n status\n routingOrder\n }\n }\n }\n}","variables":"{\n \"etchPacketEid\": \"The eid of your created Etch Packet belongs here\"\n}"}},"url":"https://graphql.useanvil.com","description":"Use the sendEtchPacket mutation to send a signature email to the current signer. \nFor packets in draft mode, this mutation will kick off the signature collection process by sending an email to the first signer.\nFor packets that have already been sent and are not in draft mode, calling this mutation will resend an email to the current signer.
\n","urlObject":{"protocol":"https","host":["graphql","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc3512d0-8dd6-4862-b720-b52419c1493c"},{"name":"Generate Etch Signing URL","id":"13a190c4-70f2-43f2-aa26-0545e9506527","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation ($signerEid: String!, $clientUserId: String!) {\n generateEtchSignURL (signerEid: $signerEid, clientUserId: $clientUserId)\n}","variables":"{\n \"signerEid\": \"The eid of the next signer belongs here. The signer's eid can be found in the response of the `createEtchPacket` mutation\",\n \"clientUserId\": \"The signer's user id in your system belongs here\"\n}"}},"url":"https://graphql.useanvil.com","description":"By default, we will solicit all signatures via email. However, if you'd like to embed the signature process into one of your own flows we support this as well.
\nBy setting the signerType of any signer in your Packet to \"embedded\", that signer will not be sent an email when it's time to sign. It will be up to you to get the signer to complete their signatures via a sign URL generated by the generateEtchSignURL mutation.
\n","urlObject":{"protocol":"https","host":["graphql","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"13a190c4-70f2-43f2-aa26-0545e9506527"},{"name":"Download Documents","id":"670a2af6-02ba-4f52-a5e8-d5386efba18a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"GET","header":[],"url":"https://app.useanvil.com/api/document-group/{{documentGroupEid}}.zip","description":"When all parties have signed, you can fetch the completed documents in zip form with this URL. Use your API key to authenticate to this URL.
\nThe documentGroupEid can be found in the response of the createEtchPacket or sendEtchPacket mutations.
The Anvil Etch E-Sign API allows you to collect e-signatures from within your app. Send a signature packet including multiple PDFs, images, and other uploads to one or more signers. Templatize your common PDFs then fill them with your user's information before sending out the signature packet.
\n","event":[{"listen":"prerequest","script":{"id":"5964045a-354f-48b3-b17a-0a1949396d89","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a65df441-fad4-46e3-911c-0806c6115315","type":"text/javascript","exec":[""]}}],"_postman_id":"cb88b2d6-07a6-401e-a3cf-90a1b4ed9db2"},{"name":"PDF Filling API","item":[{"name":"Fill PDF","event":[{"listen":"test","script":{"id":"358b255f-e89d-4b8a-a9ef-8c0c928aebf8","exec":[""],"type":"text/javascript"}}],"id":"28979889-de09-4505-bb4b-5f567f463308","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"IRS-W4\",\n \"fontSize\": 14,\n \"textColor\": \"#cf000a\",\n \"data\": {\n \"name\": {\n \"firstName\": \"Claire\",\n \"lastName\": \"Robin\"\n },\n \"address\": {\n \"street1\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94124\",\n \"country\": \"US\"\n },\n \"ssn\": \"753284832\",\n \"filingStatus\": \"Joint\",\n \"under17Cost\": 2000,\n \"otherDependentsCost\": 0,\n \"totalDependentsCost\": 2000,\n \"otherIncome\": 1500,\n \"otherDeducations\": 500,\n \"extraWithholding\": 500,\n \"employerName\": \"Aaron Jones\",\n \"firstDateEmployment\": \"2018/03/02\",\n \"employerEin\": \"5871369\",\n \"headOfHousehold\": true,\n \"twoJobs\": false,\n \"employerAddress\": {\n \"street1\": \"4832 Market Street\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.useanvil.com/api/v1/fill/XnuTZKVZg1Mljsu999od.pdf","description":"You can replace XnuTZKVZg1Mljsu999od in the URL with your PDF_TEMPLATE_EID, which can be found on the 'API Info' tab on the PDF template details page on the Anvil dashboard.
On Postman, save the PDF from the response by clicking the 'Save Response' button on the top right corner of the response tab and selecting 'Save to a file'.
The Anvil PDF Filling API allows you to fill templatized PDFs using JSON data you provide. The endpoint will allow you to fill PDFs that do not require e-signatures.
\n","_postman_id":"a86e8972-a2e5-4804-9312-8a2286fa878f"},{"name":"PDF Generation API","item":[{"name":"Generate PDF","event":[{"listen":"test","script":{"id":"8d7a3924-5329-4000-8360-2e5a82af594e","exec":[""],"type":"text/javascript"}}],"id":"3bece95a-0a71-42ce-aa78-4d25f80ca406","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Anvil Doghouse Project Invoice\",\n \"logo\": {\n \"src\": \"https://raw.githubusercontent.com/anvilco/public-assets/master/twitter.png\",\n \"maxWidth\": 120,\n \"maxHeight\": 120\n },\n \"fontSize\": 18,\n \"textColor\": \"#171717\",\n \"includeTimestamp\": true,\n \"data\": [\n {\n \"content\": \"March 4th, 2024\",\n \"fontSize\": 16,\n \"textColor\": \"#616161\"\n },\n {\n \"label\": \"To\",\n \"content\": \"Phoebe Beckett - phoebe@example.com\",\n \"fontSize\": 12,\n \"textColor\": \"#006ec2\"\n },\n {\n \"label\": \"From\",\n \"content\": \"Anvil Inc. - hello@useanvil.com\",\n \"fontSize\": 12,\n \"textColor\": \"#006ec2\"\n },\n {\n \"label\": \"Building material expenses\",\n \"table\": {\n \"rows\": [\n [\"Description\", \"Quantity\", \"Price\"],\n [\"3x Roof Shingles\", \"15\", \"$60.00\"],\n [\"5x Hardwood Plywood\", \"10\", \"$300.00\"],\n [\"80x Wood Screws\", \"80\", \"$45.00\"],\n [\n \"3x Ombre Swirl deluxe dog bed for medium dog breeds between 26 to 40 pounds. With ultra-soft synthetic fur and overstuffed dog bed with non-slide grip that pairs well with hardwood or tiled floors. Easily maintainble, easy to clean, and perfect for any home environment. Lasts over 5 years with 1 year warranty included.\",\n \"3\",\n \"$190.00\"\n ]\n ],\n \"columnOptions\": [\n { \"align\": \"left\", \"width\": \"60%\" },\n { \"align\": \"center\" , \"width\": \"100px\" },\n { \"align\": \"right\" }\n ],\n \"verticalAlign\": \"top\",\n \"firstRowHeaders\": true,\n \"rowGridlines\": true,\n \"columnGridlines\": true\n },\n \"fontSize\": 10\n },\n {\n \"label\": \"Food expenses\",\n \"table\": {\n \"rows\": [\n [\"Description\", \"Quantity\", \"Price\"],\n [\"20x Dog Biscuits\", \"20\", \"$50.00\"],\n [\"10x Air-dried Dog Food. Gently dehydrated to preserve nutrients and flavor while killing germs. No fridge or prep required. Simply pour into bowl.\", \"10\", \"$75.00\"]\n ],\n \"columnOptions\": [\n { \"align\": \"left\", \"width\": \"40%\" },\n { \"align\": \"left\" },\n { \"align\": \"left\", \"width\": \"200px\" }\n ],\n \"verticalAlign\": \"center\",\n \"firstRowHeaders\": true,\n \"rowGridlines\": false,\n \"columnGridlines\": true\n },\n \"fontSize\": 10\n },\n {\n \"label\": \"Total Amount\",\n \"table\": {\n \"rows\": [\n [\"**Tax**\", \"$64.80\"],\n [\"***Total***\", \"$784.80\"]\n ],\n \"firstRowHeaders\": false\n },\n \"fontSize\": 14,\n \"textColor\": \"#db0000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.useanvil.com/api/v1/generate-pdf","description":"This endpoint receives data in JSON format and outputs it as a PDF file.
\nOn Postman, save the PDF from the response by clicking the 'Save Response' button on the top right corner of the response tab and selecting 'Save to a file'.
\n","urlObject":{"protocol":"https","path":["api","v1","generate-pdf"],"host":["app","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bece95a-0a71-42ce-aa78-4d25f80ca406"}],"id":"9b20998d-23dc-4238-9fe5-8775c4238f78","description":"The Anvil PDF Generation API allows you to dynamically generate new PDFs using JSON data you provide via the /api/v1/generate-pdf REST endpoint. Useful for agreements, invoices, disclosures, or any other text-heavy documents.
This query will return your API user with all the main objects (welds: workflows, forges: web forms, and casts: PDF templates) on your account.
\n","urlObject":{"protocol":"https","host":["graphql","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c745a6e8-d0a2-4fad-8bdb-47fa9e415dfd"},{"name":"Query `availableQueries`","id":"03dbed1f-fe74-495d-b068-b34d9e8ff248","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"query {\n __schema {\n queryType {\n fields {\n name\n description\n }\n }\n }\n}","variables":""}},"url":"https://graphql.useanvil.com","description":"The query gathers all available queries you can use. More information can be found in the docs.
\n","urlObject":{"protocol":"https","host":["graphql","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"03dbed1f-fe74-495d-b068-b34d9e8ff248"},{"name":"Query `weld`","id":"92fa9891-adc4-4d1f-b26b-f500f7764047","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"query (\n $organizationSlug: String!,\n $slug: String!,\n $limit: Int,\n $offset: Int,\n) {\n weld (\n organizationSlug: $organizationSlug,\n slug: $slug\n ) {\n eid\n title\n weldDatas (offset: $offset, limit: $limit) {\n items {\n eid\n displayTitle\n }\n }\n }\n}","variables":"{\n \"organizationSlug\": \"The slug of your organization belongs here\",\n \"slug\": \"The slug of your weld belongs here\"\n}"}},"url":"https://graphql.useanvil.com","description":"Fetching the weld is the best way to fetch the data submitted to a given workflow (weld). An instances of a workflow is called a weldData. More info here.
\n","urlObject":{"protocol":"https","host":["graphql","useanvil","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"92fa9891-adc4-4d1f-b26b-f500f7764047"},{"name":"Query `weldData`","id":"129cc2fe-3e5e-4d07-97e6-b327234c4456","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"YOUR_ANVIL_API_KEY"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"query ($eid: String!) {\n weldData (\n eid: $eid\n ) {\n eid\n displayTitle\n status\n isComplete\n isCompleteAndSigned\n isTest\n completionPercentage\n numberRemainingSigners\n documentGroup {\n eid\n status\n }\n submissions {\n eid\n status\n continueURL\n }\n }\n}","variables":"{\n \"eid\": \"The eid of your weldData belongs here\" \n}"}},"url":"https://graphql.useanvil.com","description":"An instance of a workflow(weld) is called a weldData. This is a direct way to fetch the data of a workflow instance. More info here.
forgeSubmit allows you to create new submissions and update data for a given workflow. Use forgeSubmit only if you need total programmatic control. A simpler way to start workflows is with our Form UI URLs.
The Anvil GraphQL API gives you insight into your account and the objects it owns, allow you to create, update, start, and submit data to workflows.
\n","_postman_id":"56961974-cdc0-4cf6-92e2-67bd76d15fd7"}],"event":[{"listen":"prerequest","script":{"id":"7e9c2728-7493-464f-a522-ff58960bb828","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cf21c792-2392-466b-8bdd-25059aa1835e","type":"text/javascript","exec":["pm.test('Success!', function () {"," pm.response.to.have.status(200)"," pm.response.to.not.have.jsonBody(\"errors\")","})"]}}],"variable":[{"key":"API_KEY","value":"YOUR_ANVIL_API_KEY"},{"key":"PDF_TEMPLATE_ID\n","value":"XnuTZKVZg1Mljsu999od"}]}