{"openapi":"3.1.0","info":{"title":"Pandafile API","version":"2026-11-27","summary":"Send large files, collect uploads and get documents signed – from your own code.","description":"The Pandafile API is included with Pro and Team. It follows the same rules and limits as the website.\n\n**Authentication.** `Authorization: Bearer pf_live_…` with a key from Dashboard → Domain & API. Keys have a scope (read, write or full). Test keys (`pf_test_…`) create test transfers: nobody is emailed, they expire after 24 hours, count toward no limit, and webhook events say `\"livemode\": false`.\n**Versioning.** Send `Pandafile-Version: 2026-11-27`. Without it a request uses the version its key is pinned to (keys made before 2026-11-27 stay on 2025-06-01). Versions: 2025-06-01 – The original API. Errors are {\"error\": \"<message>\"} (in the language of Accept-Language). Lists that existed then keep their keys (GET /transfers → transfers + next, GET /hooks → hooks, GET /events → events) with has_more and next_cursor added. POST /transfers answers 200. 2026-11-27 – Errors are {\"error\": {\"type\", \"code\", \"message\", \"param\"?}} with English messages. Every list is {\"object\": \"list\", \"data\": [...], \"has_more\", \"next_cursor\"}. Creating anything answers 201.\n**Errors.** `{\"error\": {\"type\", \"code\", \"message\", \"param\"?}}` with the HTTP status. Every response has `X-Request-Id` (send your own to correlate).\n**Rate limits.** 120 requests per minute per key (burst 120), reported in RateLimit-Limit / RateLimit-Remaining / RateLimit-Reset; 429 comes with Retry-After.\n**Idempotency.** Send `Idempotency-Key: <unique string>` with POST, PATCH and PUT. Retrying with the same key and body within 24 hours replays the first response (header Idempotent-Replayed: true); a different body gives 409.\n**Pagination.** Lists take `limit` (1–100) and `starting_after` (the `next_cursor` of the previous page) and return `has_more`.\n**Uploads.** Files go to the tus endpoint returned when you create a transfer (resumable, any size your plan allows).","contact":{"name":"Pandafile","url":"https://pandafile.co/developers"},"termsOfService":"https://pandafile.co/terms"},"externalDocs":{"description":"Guide: uploads with tus, webhooks and signatures","url":"https://pandafile.co/developers"},"servers":[{"url":"https://pandafile.co/api/v1","description":"Production"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Transfers","description":"Create transfers, upload with tus, share links and email recipients; follow downloads, statistics and approvals."},{"name":"File requests","description":"Pages where anyone with the link can upload files to you (Pro/Team)."},{"name":"Signatures","description":"Send PDFs for signature: upload, add signers and fields, send, remind, download the signed PDF."},{"name":"Branding","description":"Your name, colour, logo and background on download and request pages."},{"name":"Team","description":"Seats, members and invites (team owners)."},{"name":"Webhooks","description":"Events by polling, and REST hook subscriptions (Zapier, Make, your own endpoint)."},{"name":"Account","description":"The key's account: plan, limits, usage, keys and download domains."},{"name":"Meta","description":"About this API."}],"paths":{"/openapi.json":{"get":{"operationId":"getOpenApi","tags":["Meta"],"summary":"This API as an OpenAPI 3.1 document","description":"Public, no key needed. Generated from the same route table that serves the requests.","parameters":[],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[],"x-pandafile-scope":null,"x-pandafile-test-mode":null}},"/me":{"get":{"operationId":"getMe","tags":["Account"],"summary":"The key's account: plan, limits and usage","description":"The effective plan (team for a Team owner, pro for Pro and for members of an active team), the limits that come with it, and usage this week and month.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Me"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/keys":{"get":{"operationId":"listApiKeys","tags":["Account"],"summary":"List API keys","description":"Your active API keys (never the secret itself). Keys are created and revoked in the dashboard.","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/domains":{"get":{"operationId":"listDomains","tags":["Account"],"summary":"List download domains","description":"Your own download domains (for a team member: the owner's) with their verification status.","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/domains/{id}":{"get":{"operationId":"getDomain","tags":["Account"],"summary":"Get a download domain","parameters":[{"name":"id","in":"path","required":true,"description":"Domain id.","schema":{"type":"string","pattern":"^[0-9]{1,12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Domain"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/transfers":{"post":{"operationId":"createTransfer","tags":["Transfers"],"summary":"Create a transfer","description":"Announces the files. Then upload each file with tus to uploadEndpoint (metadata transferId, ownerToken, filename, filetype) and call complete. With a test key the transfer is test data: nobody is emailed, it expires after 24 hours and counts toward no limit.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferCreated"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferCreate"},"example":{"title":"Final cut","files":[{"name":"film.mp4","size":734003200}],"recipients":["client@example.com"]}}}}},"get":{"operationId":"listTransfers","tags":["Transfers"],"summary":"List transfers","description":"Newest first. view=active (default: live and uploading) or history (expired, deleted, blocked). Test keys list test transfers only.","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"name":"view","in":"query","required":false,"description":"Which transfers.","schema":{"type":"string","enum":["active","history"]}},{"name":"q","in":"query","required":false,"description":"Search title, id, recipient or file name.","schema":{"type":"string"}},{"name":"before","in":"query","required":false,"description":"Legacy cursor (created_at of the last item); prefer starting_after.","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Transfer"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/transfers/from-url":{"post":{"operationId":"createTransferFromUrl","tags":["Transfers"],"summary":"Create a transfer from URLs","description":"Pandafile downloads each https URL itself (public addresses only, at most 3 redirects, up to your plan's per-transfer limit), creates the transfer and completes it – the way Zapier and Make send files. Waits up to 20 seconds: 201 with status \"ready\", or 202 with status \"uploading\" while big files keep downloading in the background (progress: GET /transfers/{id}/import). If a download fails, the transfer is deleted and the import reports the error. With a test key the transfer is test data (nobody is emailed, 24-hour expiry).","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFromUrlResult"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"202":{"description":"Accepted: the files are still downloading (status \"uploading\"). The transfer.ready webhook fires when it is done.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFromUrlResult"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFromUrl"},"example":{"title":"Invoices March","files":[{"url":"https://example.com/exports/invoices-march.pdf"}],"recipients":["accounts@example.com"]}}}}}},"/transfers/{id}":{"get":{"operationId":"getTransfer","tags":["Transfers"],"summary":"Get a transfer","description":"The transfer with its files, recipients (who downloaded, reminders), the latest downloads, approvals and link statistics.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferDetail"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true},"patch":{"operationId":"updateTransfer","tags":["Transfers"],"summary":"Update a transfer","description":"Change title and message, extend the expiry (Pro/Team, up to 90 days after sending: GET /transfers/{id} returns that limit as transfer.max_expires_at), or set / clear the download password. Live transfers only.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferDetail"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferUpdate"},"example":{"title":"Final cut v2","password":"blue-river-42"}}}}},"delete":{"operationId":"deleteTransfer","tags":["Transfers"],"summary":"Delete a transfer","description":"Deletes the files now; the link stops working.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deleted"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true}},"/transfers/{id}/complete":{"post":{"operationId":"completeTransfer","tags":["Transfers"],"summary":"Complete a transfer","description":"After every file is uploaded: the link goes live and recipients are emailed (never in test mode). Calling it again is harmless.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"url":{"type":"string"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ownerToken":{"type":"string","description":"From the create response."}},"required":["ownerToken"]}}}}}},"/transfers/{id}/recipients":{"post":{"operationId":"addTransferRecipients","tags":["Transfers"],"summary":"Add recipients and send","description":"Each new address gets an email with a personal link (test mode: recorded, never emailed). Addresses already on the transfer are skipped.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"added":{"type":"integer"},"emailed":{"type":"boolean"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":["array","string"],"items":{"type":"string","format":"email"},"description":"Addresses (array, or one string separated by commas)."}},"required":["emails"],"example":{"emails":["producer@example.com"]}},"example":{"emails":["producer@example.com"]}}}}}},"/transfers/{id}/remind":{"post":{"operationId":"remindTransferRecipient","tags":["Transfers"],"summary":"Resend the link to a recipient","description":"Emails the recipient their personal link again and turns their reminders back on. At most twice an hour per recipient.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"emailed":{"type":"boolean"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"A recipient of this transfer."}},"required":["email"]}}}}}},"/transfers/{id}/import":{"get":{"operationId":"getTransferImport","tags":["Transfers"],"summary":"Progress of a URL import","description":"For transfers made with POST /transfers/from-url: per file bytes received, then ready or failed (with the error). Kept for 24 hours.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferImport"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/transfers/{id}/downloads":{"get":{"operationId":"listTransferDownloads","tags":["Transfers"],"summary":"List downloads of a transfer","description":"Newest first: when, which file (or zip) and – for personal links – which recipient.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Download"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/transfers/{id}/stats":{"get":{"operationId":"getTransferStats","tags":["Transfers"],"summary":"Link statistics","description":"Page views (first/last), downloads per file and recipient, countries and device types. Counters only – no IP addresses.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkStats"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/transfers/{id}/feedback":{"get":{"operationId":"getTransferFeedback","tags":["Transfers"],"summary":"Approvals and comments","description":"What recipients answered on the download page (Approve / Request changes), newest first, with a summary status.","parameters":[{"name":"id","in":"path","required":true,"description":"Transfer id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feedback"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/requests":{"get":{"operationId":"listFileRequests","tags":["File requests"],"summary":"List file requests","description":"Open requests first, then closed ones; newest first.","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FileRequest"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false},"post":{"operationId":"createFileRequest","tags":["File requests"],"summary":"Create a file request","description":"A page (url) where anyone with the link can upload files to you. Uploads land privately in your account (Pro/Team).","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequest"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequestCreate"},"example":{"title":"Photos from the wedding","message":"Drop your best shots here – thank you!"}}}}}},"/requests/{id}":{"get":{"operationId":"getFileRequest","tags":["File requests"],"summary":"Get a file request","parameters":[{"name":"id","in":"path","required":true,"description":"File request id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequest"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false},"patch":{"operationId":"updateFileRequest","tags":["File requests"],"summary":"Update a file request","description":"Title, message, and open (false closes the upload page, true reopens it).","parameters":[{"name":"id","in":"path","required":true,"description":"File request id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequest"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequestUpdate"}}}}},"delete":{"operationId":"deleteFileRequest","tags":["File requests"],"summary":"Delete a file request","description":"Deletes the request and every file uploaded into it. Cannot be undone.","parameters":[{"name":"id","in":"path","required":true,"description":"File request id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"deleted":{"type":"boolean"},"uploads_deleted":{"type":"integer"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false}},"/requests/{id}/close":{"post":{"operationId":"closeFileRequest","tags":["File requests"],"summary":"Close a file request","description":"The upload page stops accepting files. Uploaded files stay.","parameters":[{"name":"id","in":"path","required":true,"description":"File request id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequest"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false}},"/requests/{id}/reopen":{"post":{"operationId":"reopenFileRequest","tags":["File requests"],"summary":"Reopen a file request","parameters":[{"name":"id","in":"path","required":true,"description":"File request id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequest"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false}},"/requests/{id}/uploads":{"get":{"operationId":"listFileRequestUploads","tags":["File requests"],"summary":"List uploads of a file request","description":"Each upload is a private transfer (download it while signed in, or through the dashboard).","parameters":[{"name":"id","in":"path","required":true,"description":"File request id.","schema":{"type":"string","pattern":"^[a-z0-9]{6,20}$"}},{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FileRequestUpload"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false}},"/signatures":{"post":{"operationId":"createSignatureRequest","tags":["Signatures"],"summary":"Upload a PDF for signature","description":"Send the PDF itself as the body (Content-Type: application/pdf, up to 25 MB / 200 pages). Creates a draft: add signers and fields with PATCH, then send.","parameters":[{"name":"name","in":"query","required":false,"description":"File name (e.g. contract.pdf).","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureUploaded"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false,"requestBody":{"required":true,"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"description":"The file itself, up to 25600 KB."}},"get":{"operationId":"listSignatureRequests","tags":["Signatures"],"summary":"List signature requests","description":"Newest first, with each signer's status.","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SignatureRequest"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false}},"/signatures/{id}":{"get":{"operationId":"getSignatureRequest","tags":["Signatures"],"summary":"Get a signature request","description":"The request, signers, fields, audit events and this month's usage.","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureDetail"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false},"patch":{"operationId":"updateSignatureRequest","tags":["Signatures"],"summary":"Edit a draft: title, message, signers and fields","description":"Drafts only. signers and fields replace the current ones when given; whatever you leave out stays.","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureDetail"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureDraft"},"example":{"title":"NDA","signers":[{"name":"Ada Lovelace","email":"ada@example.com"}],"fields":[{"signer":0,"kind":"signature","page":0,"x":0.1,"y":0.8,"w":0.3,"h":0.06}]}}}}},"delete":{"operationId":"deleteSignatureRequest","tags":["Signatures"],"summary":"Delete a signature request","description":"Any status: the files and the record go (the monthly count stays).","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false}},"/signatures/{id}/send":{"post":{"operationId":"sendSignatureRequest","tags":["Signatures"],"summary":"Send for signature","description":"Optionally with the same fields as PATCH. Every signer gets an email with a personal link; signing closes after 30 days.","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureDetail"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureDraft"},"example":{"title":"NDA","signers":[{"name":"Ada Lovelace","email":"ada@example.com"}],"fields":[{"signer":0,"kind":"signature","page":0,"x":0.1,"y":0.8,"w":0.3,"h":0.06}]}}}}}},"/signatures/{id}/remind":{"post":{"operationId":"remindSigners","tags":["Signatures"],"summary":"Remind signers","description":"Signers who have not signed yet, at most once per signer per 24 hours.","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"reminded":{"type":"integer"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false}},"/signatures/{id}/cancel":{"post":{"operationId":"cancelSignatureRequest","tags":["Signatures"],"summary":"Cancel a sent request","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"status":{"type":"string"}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":false}},"/signatures/{id}/document.pdf":{"get":{"operationId":"downloadSignatureOriginal","tags":["Signatures"],"summary":"Download the original PDF","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"The file.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false}},"/signatures/{id}/signed.pdf":{"get":{"operationId":"downloadSignedPdf","tags":["Signatures"],"summary":"Download the signed PDF","description":"Completed requests: every field stamped in and the audit trail appended. 409 until everyone has signed.","parameters":[{"name":"id","in":"path","required":true,"description":"Signature request id.","schema":{"type":"string","pattern":"^[23456789abcdefghjkmnpqrstuvwxyz]{12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"The file.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":false}},"/branding":{"get":{"operationId":"getBranding","tags":["Branding"],"summary":"Get branding","description":"Name, accent colour, logo and background on your download pages, file-request pages and emails.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true},"patch":{"operationId":"updateBranding","tags":["Branding"],"summary":"Update branding","description":"Name (Plus and up) and accent colour (Pro/Team). Fields left out stay.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingUpdate"},"example":{"name":"Studio Nord","color":"#1F7A4D"}}}}}},"/branding/logo":{"put":{"operationId":"uploadBrandingLogo","tags":["Branding"],"summary":"Upload the logo","description":"The image itself as the body: PNG, JPEG or WebP, up to 600 KB.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false,"requestBody":{"required":true,"content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"description":"The file itself, up to 600 KB."}},"delete":{"operationId":"deleteBrandingLogo","tags":["Branding"],"summary":"Remove the logo","parameters":[{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false}},"/branding/background":{"put":{"operationId":"uploadBrandingBackground","tags":["Branding"],"summary":"Upload the background image","description":"The image itself as the body: PNG, JPEG or WebP, up to 4 MB (Pro/Team).","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false,"requestBody":{"required":true,"content":{"image/png":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"description":"The file itself, up to 4096 KB."}},"delete":{"operationId":"deleteBrandingBackground","tags":["Branding"],"summary":"Remove the background image","parameters":[{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Branding"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false}},"/team":{"get":{"operationId":"getTeam","tags":["Team"],"summary":"Get your team (owner)","description":"Seats, members with this month's usage, and open invites. Team owners only.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/team/members":{"get":{"operationId":"listTeamMembers","tags":["Team"],"summary":"List team members (owner)","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/team/invites":{"get":{"operationId":"listTeamInvites","tags":["Team"],"summary":"List open invites (owner)","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TeamInvite"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true},"post":{"operationId":"createTeamInvites","tags":["Team"],"summary":"Invite people (owner)","description":"Each address gets an email with a join link valid for 14 days. Members plus open invites may not exceed the seats.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"invites":{"type":"array","items":{"$ref":"#/components/schemas/TeamInvite"}}}}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false,"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamInviteCreate"},"example":{"emails":["sam@example.com"]}}}}}},"/team/invites/{id}":{"delete":{"operationId":"revokeTeamInvite","tags":["Team"],"summary":"Revoke an invite (owner)","parameters":[{"name":"id","in":"path","required":true,"description":"Invite id.","schema":{"type":"string","pattern":"^[0-9]{1,12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"full","x-pandafile-test-mode":false}},"/events":{"get":{"operationId":"listEvents","tags":["Webhooks"],"summary":"List events (polling)","description":"The last 30 days of events, newest first. Live keys see live events, test keys test events (livemode: false).","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 50).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"name":"since","in":"query","required":false,"description":"Only newer than this: ISO time, unix seconds or an event id.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"One event type.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true}},"/hooks":{"get":{"operationId":"listHooks","tags":["Webhooks"],"summary":"List REST hook subscriptions","description":"Subscriptions made through the API (Zapier, Make, your own code). Dashboard webhooks are managed in the dashboard.","parameters":[{"name":"limit","in":"query","required":false,"description":"Page size (1–100, default 20).","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"starting_after","in":"query","required":false,"description":"Cursor: the next_cursor of the previous page.","schema":{"type":"string"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Hook"}},"has_more":{"type":"boolean","description":"More items follow: pass next_cursor as starting_after."},"next_cursor":{"type":["string","null"],"description":"starting_after value for the next page (null on the last page)."}},"required":["object","data","has_more","next_cursor"]}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true},"post":{"operationId":"createHook","tags":["Webhooks"],"summary":"Subscribe a URL to events","description":"Deliveries are signed (header Pandafile-Signature, see the guide) with the secret in the response, shown once. Ends when the key is revoked.","parameters":[{"$ref":"#/components/parameters/PandafileVersion"},{"$ref":"#/components/parameters/IdempotencyKey"}],"responses":{"201":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HookCreated"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"409":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true,"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HookCreate"},"example":{"url":"https://example.com/pandafile-webhook","events":["transfer.ready","transfer.downloaded"]}}}}}},"/hooks/{id}":{"get":{"operationId":"getHook","tags":["Webhooks"],"summary":"Get a subscription","parameters":[{"name":"id","in":"path","required":true,"description":"Hook id.","schema":{"type":"string","pattern":"^[0-9]{1,12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hook"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"read","x-pandafile-test-mode":true},"delete":{"operationId":"deleteHook","tags":["Webhooks"],"summary":"Unsubscribe","parameters":[{"name":"id","in":"path","required":true,"description":"Hook id.","schema":{"type":"string","pattern":"^[0-9]{1,12}$"}},{"$ref":"#/components/parameters/PandafileVersion"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ok"}}},"headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"Pandafile-Version":{"$ref":"#/components/headers/Pandafile-Version"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/RateLimited"},"default":{"$ref":"#/components/responses/Error"}},"x-pandafile-scope":"write","x-pandafile-test-mode":true}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"pf_live_… | pf_test_…","description":"API key from the dashboard. Scopes: read – GET requests only. write – Read, plus create / change / delete transfers, file requests, signature requests and hook subscriptions. full – Everything, including account settings: branding and team invites."}},"parameters":{"PandafileVersion":{"name":"Pandafile-Version","in":"header","required":false,"description":"API version (YYYY-MM-DD). Default: the key's pinned version.","schema":{"type":"string","enum":["2025-06-01","2026-11-27"],"example":"2026-11-27"}},"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"description":"Unique key (1–255 visible characters) so a retry never does the work twice. Kept 24 hours.","schema":{"type":"string","maxLength":255}}},"headers":{"X-Request-Id":{"description":"Identifies this request (quote it when you contact support).","schema":{"type":"string"}},"Pandafile-Version":{"description":"The version this response was written in.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"Requests allowed per minute for this key.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left right now.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the full limit is available again.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"responses":{"Error":{"description":"Error. type: invalid_request_error – The request was wrong: a missing or invalid parameter, an unknown id, or a state that does not allow it. authentication_error – No API key, or the key is unknown, revoked or malformed. permission_error – The key is valid but may not do this (plan, key scope, test mode, team role). idempotency_error – The Idempotency-Key was used before with a different request, or that request is still running. rate_limit_error – Too many requests for this key. Wait Retry-After seconds. api_error – Something went wrong on our side. Safe to retry with the same Idempotency-Key.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limit reached.","headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error category.","enum":["invalid_request_error","authentication_error","permission_error","idempotency_error","rate_limit_error","api_error"]},"code":{"type":"string","description":"Stable machine-readable code, e.g. resource_missing, parameter_invalid, plan_required, scope_insufficient, test_mode_unsupported, rate_limited, idempotency_key_reused."},"message":{"type":"string","description":"Human-readable English description."},"param":{"type":"string","description":"The parameter or header that caused the error, when known."}},"required":["type","code","message"]}},"required":["error"],"example":{"error":{"type":"invalid_request_error","code":"resource_missing","message":"No such transfer."}}},"LegacyError":{"type":"object","properties":{"error":{"type":"string","description":"Message in the language of Accept-Language (API version 2025-06-01 only)."}},"required":["error"]},"Ok":{"type":"object","properties":{"ok":{"type":"boolean","const":true}},"required":["ok"]},"Deleted":{"type":"object","properties":{"ok":{"type":"boolean","const":true},"id":{"type":"string","description":"Id of the deleted object."},"deleted":{"type":"boolean","const":true}},"required":["ok","id","deleted"]},"Plan":{"type":"object","properties":{"name":{"type":"string","description":"Plan id.","enum":["free","plus","pro","team"]},"max_transfer_bytes":{"type":"integer","description":"Largest single transfer."},"storage_bytes":{"type":["integer","null"],"description":"Live storage (everything not yet expired counts until it expires)."},"monthly_bytes":{"type":["integer","null"],"description":"Fair-use volume per calendar month (Plus)."},"expiry_days":{"type":"integer","description":"Default lifetime of a transfer."},"max_expiry_days":{"type":"integer","description":"Longest lifetime after extending."},"features":{"type":"object","properties":{"password":{"type":"boolean","description":""},"requests":{"type":"boolean","description":"File requests."},"branding":{"type":"boolean","description":""},"extend":{"type":"boolean","description":"Extend expiry."},"e2ee":{"type":"boolean","description":"End-to-end encryption."},"api":{"type":"boolean","description":""}}}}},"Me":{"type":"object","properties":{"email":{"type":"string","description":"Account email."},"name":{"type":["string","null"]},"plan":{"type":"string","description":"Effective plan right now: team for a Team owner, pro for Pro and for members of an active team.","enum":["free","plus","pro","team"]},"own_plan":{"type":"string","description":"What the account pays for itself."},"team":{"type":["object","null"],"properties":{"id":{"type":"string","description":""},"name":{"type":["string","null"]},"role":{"type":"string","description":"","enum":["owner","member"]}}},"maxTransferBytes":{"type":"integer","description":"Same as limits.max_transfer_bytes (kept for API version 2025-06-01)."},"expiryDays":{"type":"integer","description":"Same as limits.expiry_days (kept for API version 2025-06-01)."},"limits":{"$ref":"#/components/schemas/Plan"},"usage":{"type":"object","properties":{"week_bytes":{"type":"integer","description":"Bytes sent in the last 7 days (test mode excluded)."},"month_bytes":{"type":"integer","description":"Bytes uploaded this calendar month (the fair-use counter)."},"storage_bytes":{"type":"integer","description":"Bytes your live transfers hold now."},"week_transfers":{"type":"integer","description":"Transfers sent in the last 7 days."},"month_transfers":{"type":"integer","description":"Transfers sent this calendar month."}}},"livemode":{"type":"boolean","description":"false for a test key."},"api_version":{"type":"string","description":"Version this response was written in."},"key":{"type":"object","properties":{"id":{"type":"integer","description":""},"name":{"type":"string","description":""},"prefix":{"type":"string","description":""},"mode":{"type":"string","description":"","enum":["live","test"]},"scope":{"type":"string","description":"","enum":["read","write","full"]}}}},"required":["email","plan"]},"ApiKey":{"type":"object","properties":{"id":{"type":"integer","description":""},"name":{"type":"string","description":""},"prefix":{"type":"string","description":"First characters of the key (pf_live_ab12)."},"createdAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":["string","null"],"format":"date-time","description":""},"revoked":{"type":"boolean","description":""},"mode":{"type":"string","description":"","enum":["live","test"]},"scope":{"type":"string","description":"","enum":["read","write","full"]},"apiVersion":{"type":["string","null"],"description":"Pinned version (null = 2025-06-01)."}}},"Domain":{"type":"object","properties":{"id":{"type":"integer","description":""},"domain":{"type":"string","description":"e.g. files.example.com"},"status":{"type":"string","description":"","enum":["pending","verified","failed"]},"lastError":{"type":["string","null"]},"checkedAt":{"type":["string","null"],"format":"date-time","description":""},"verifiedAt":{"type":["string","null"],"format":"date-time","description":""},"dns":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"","enum":["CNAME","TXT"]},"name":{"type":"string","description":""},"value":{"type":"string","description":""}}},"description":"Records to create at your DNS provider."}}},"TransferCreate":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"File name, folders allowed (photos/day1/a.jpg)."},"size":{"type":"integer","description":"Bytes.","minimum":1},"type":{"type":"string","description":"MIME type (optional)."}},"required":["name","size"]},"description":"The files you are going to upload (1–500)."},"title":{"type":"string","description":"Up to 120 characters."},"message":{"type":"string","description":"Up to 1000 characters."},"recipients":{"type":"array","items":{"type":"string","description":"","format":"email"},"description":"Emailed a personal link when the transfer completes (never in test mode)."},"password":{"type":"string","description":"Download password."}},"required":["files"],"example":{"title":"Final cut","files":[{"name":"film.mp4","size":734003200}],"recipients":["client@example.com"]}},"TransferCreated":{"type":"object","properties":{"id":{"type":"string","description":"Transfer id."},"ownerToken":{"type":"string","description":"Secret for the tus uploads (metadata ownerToken) and for completing. Shown once."},"url":{"type":"string","description":"Share link (your own domain when connected)."},"uploadEndpoint":{"type":"string","description":"tus endpoint for the files."},"maxBytes":{"type":"integer","description":"Bytes reserved."},"expiresInDays":{"type":"integer","description":""},"encrypted":{"type":"boolean","description":""},"livemode":{"type":"boolean","description":""}},"required":["id","ownerToken","url","uploadEndpoint"]},"Transfer":{"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":["string","null"]},"status":{"type":"string","description":"","enum":["uploading","ready","expired","deleted","blocked"]},"file_count":{"type":"integer","description":""},"total_bytes":{"type":"integer","description":""},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"download_count":{"type":"integer","description":""},"plan":{"type":"string","description":""},"has_password":{"type":"boolean","description":""},"encrypted":{"type":"boolean","description":""},"recipients":{"type":"integer","description":"Number of recipients."},"downloaded_by":{"type":"integer","description":"Recipients who downloaded."},"url":{"type":["string","null"]},"livemode":{"type":"boolean","description":""}}},"TransferFromUrl":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"https URL of the file. Redirects (at most 3) are followed; every hop must be a public https address."},"name":{"type":"string","description":"File name to use (default: from Content-Disposition, else the last part of the URL path)."}},"required":["url"]},"description":"1–20 files."},"title":{"type":["string","null"],"description":"Up to 120 characters."},"message":{"type":["string","null"],"description":"Up to 1000 characters."},"recipients":{"type":["array","string","null"],"items":{"type":"string","format":"email"},"description":"Emailed a personal link when the transfer is ready (never in test mode). Array, or one string separated by commas."},"password":{"type":["string","null"],"description":"Download password (8–200 characters)."},"expires_at":{"type":["string","null"],"description":"Expiry (ISO 8601), from 1 hour up to 90 days from now. Not for test keys.","format":"date-time"},"async":{"type":["boolean","string","null"],"description":"true: answer 202 straight away instead of waiting up to 20 seconds for the files."}},"required":["files"],"description":"Empty optional fields (null or \"\") count as not given – no-code tools send them that way.","example":{"title":"Invoices March","files":[{"url":"https://example.com/exports/invoices-march.pdf"}],"recipients":["accounts@example.com"]}},"TransferImport":{"type":"object","properties":{"object":{"type":"string","const":"transfer_import"},"id":{"type":"string","description":"Transfer id."},"status":{"type":"string","description":"downloading → ready, or failed (the transfer is then deleted).","enum":["downloading","ready","failed"]},"livemode":{"type":"boolean","description":""},"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":["string","null"]},"source_host":{"type":["string","null"]},"status":{"type":"string","description":"","enum":["pending","downloading","done","failed"]},"bytes_received":{"type":"integer","description":""},"bytes_total":{"type":["integer","null"],"description":"null while the size is unknown."}}}},"bytes_received":{"type":"integer","description":"All files together."},"error":{"anyOf":[{"type":"null"},{"type":"object","description":"Same fields as an API error (type, code, message, param, reason)."}]},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time","description":""}},"required":["object","id","status"]},"TransferFromUrlResult":{"type":"object","properties":{"id":{"type":"string","description":"Transfer id."},"object":{"type":"string","const":"transfer"},"status":{"type":"string","description":"ready (201) or uploading (202: still downloading – watch GET /transfers/{id}/import or the transfer.ready webhook).","enum":["ready","uploading"]},"url":{"type":"string","description":"Share link (works once the transfer is ready)."},"title":{"type":["string","null"]},"expires_at":{"type":["string","null"],"format":"date-time","description":""},"recipients":{"type":"array","items":{"type":"string","description":""}},"livemode":{"type":"boolean","description":""},"import":{"$ref":"#/components/schemas/TransferImport"}},"required":["id","status","url","import"]},"Recipient":{"type":"object","properties":{"email":{"type":"string","description":""},"sent":{"type":["string","null"],"format":"date-time","description":"When the link was emailed."},"downloaded":{"type":["string","null"],"format":"date-time","description":"First download."},"reminded":{"type":["string","null"],"format":"date-time","description":""},"remindersOff":{"type":"boolean","description":""}}},"Download":{"type":"object","properties":{"id":{"type":"integer","description":""},"at":{"type":"string","format":"date-time"},"kind":{"type":"string","description":"","enum":["file","zip"]},"file":{"type":["string","null"]},"recipient":{"type":["string","null"]}}},"TransferDetail":{"type":"object","properties":{"transfer":{"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":["string","null"]},"message":{"type":["string","null"]},"status":{"type":"string","description":""},"file_count":{"type":"integer","description":""},"total_bytes":{"type":"integer","description":""},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"download_count":{"type":"integer","description":""},"plan":{"type":"string","description":""},"has_password":{"type":"boolean","description":""},"url":{"type":["string","null"]},"request_id":{"type":["string","null"]},"encrypted":{"type":"boolean","description":""},"livemode":{"type":"boolean","description":""},"can_send_again":{"type":"boolean","description":"The transfer can be sent again as a new transfer from the dashboard (\"Send again\"): live, your own share link (not a file request upload), not test data and not end-to-end encrypted."},"max_expires_at":{"type":["string","null"],"format":"date-time","description":"The latest expires_at this transfer can be given (PATCH expires_at or extend): created_at plus your plan's max_expiry_days. null when the transfer is not live (still uploading, expired, deleted or blocked), is test data, or your plan cannot change the expiry."}}},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"size":{"type":"integer","description":""}}}},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/Recipient"}},"log":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"kind":{"type":"string","description":""},"file":{"type":["string","null"]},"recipient":{"type":["string","null"]}}},"description":"Latest 100 downloads."},"approval":{"$ref":"#/components/schemas/Feedback","type":[null,"null"]},"stats":{"$ref":"#/components/schemas/LinkStats","type":[null,"null"]},"features":{"type":"object","properties":{"approval":{"type":"boolean","description":""},"stats":{"type":"boolean","description":""}}}}},"TransferUpdate":{"type":"object","properties":{"title":{"type":["string","null"],"description":"New title (null clears)."},"message":{"type":["string","null"],"description":"New message (null clears)."},"expires_at":{"type":"string","description":"Later expiry, at most 90 days after the transfer was sent (Pro/Team): the transfer's max_expires_at.","format":"date-time"},"extend":{"type":"boolean","description":"true: 30 more days (same as the dashboard button), within the same 90 days."},"password":{"type":["string","null"],"description":"Set (4–200 characters) or clear (null or \"\") the download password."}},"example":{"title":"Final cut v2","password":"blue-river-42"}},"LinkStats":{"type":"object","properties":{"views":{"type":"integer","description":""},"firstView":{"type":["string","null"],"format":"date-time","description":""},"lastView":{"type":["string","null"],"format":"date-time","description":""},"downloads":{"type":"integer","description":""},"zip":{"type":"integer","description":"Zip downloads."},"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"downloads":{"type":"integer","description":""}}}},"recipients":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":""},"views":{"type":"integer","description":""},"lastView":{"type":["string","null"],"format":"date-time","description":""},"downloads":{"type":"integer","description":""}}}},"countries":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"ISO country, ZZ = unknown"},"count":{"type":"integer","description":""}}}},"downloads":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"count":{"type":"integer","description":""}}}}}},"devices":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"count":{"type":"integer","description":""}}}},"downloads":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":""},"count":{"type":"integer","description":""}}}}}}}},"Feedback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Approvals are on for transfers sent on Pro/Team."},"status":{"type":"string","description":"","enum":["none","approved","changes"]},"approved":{"type":"integer","description":""},"changes":{"type":"integer","description":""},"items":{"type":"array","items":{"type":"object","properties":{"decision":{"type":"string","description":"","enum":["approved","changes"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"comment":{"type":["string","null"]},"at":{"type":"string","format":"date-time"}}}}}},"FileRequest":{"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":"string","description":""},"message":{"type":["string","null"]},"open":{"type":"boolean","description":"Accepting uploads."},"url":{"type":"string","description":"Upload page to share."},"created_at":{"type":"string","format":"date-time"},"closed_at":{"type":["string","null"],"format":"date-time","description":""},"upload_count":{"type":"integer","description":""},"last_upload":{"type":["string","null"],"format":"date-time","description":""}}},"FileRequestCreate":{"type":"object","properties":{"title":{"type":"string","description":"Up to 120 characters."},"message":{"type":"string","description":"Shown on the upload page, up to 1000 characters."}},"required":["title"],"example":{"title":"Photos from the wedding","message":"Drop your best shots here – thank you!"}},"FileRequestUpdate":{"type":"object","properties":{"title":{"type":"string","description":""},"message":{"type":["string","null"]},"open":{"type":"boolean","description":"false closes, true reopens."}}},"FileRequestUpload":{"type":"object","properties":{"id":{"type":"string","description":"Transfer id."},"title":{"type":["string","null"]},"message":{"type":["string","null"]},"uploader_name":{"type":["string","null"]},"uploader_email":{"type":["string","null"]},"file_count":{"type":"integer","description":""},"total_bytes":{"type":"integer","description":""},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"status":{"type":"string","description":""},"download_count":{"type":"integer","description":""},"url":{"type":["string","null"]}}},"Signer":{"type":"object","properties":{"name":{"type":"string","description":""},"email":{"type":"string","description":"","format":"email"}},"required":["name","email"]},"SignatureField":{"type":"object","properties":{"signer":{"type":"integer","description":"Index into signers."},"kind":{"type":"string","description":"","enum":["signature","initials","date","name","text"]},"page":{"type":"integer","description":"0-based page."},"x":{"type":"number","description":"Left edge as a fraction of the page width (0–1)."},"y":{"type":"number","description":"Top edge as a fraction of the page height."},"w":{"type":"number","description":"Width as a fraction of the page width."},"h":{"type":"number","description":"Height as a fraction of the page height."},"required":{"type":"boolean","description":"Default true."}},"required":["signer","kind","page","x","y","w","h"]},"SignatureDraft":{"type":"object","properties":{"title":{"type":"string","description":""},"message":{"type":"string","description":"Shown to signers."},"lang":{"type":"string","description":"Language of the signer emails and page (en, de, fr, …)."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/Signer"},"description":"Replaces the signers (1–10 to send)."},"fields":{"type":"array","items":{"$ref":"#/components/schemas/SignatureField"},"description":"Replaces the fields; every signer needs a signature field to send."}},"example":{"title":"NDA","signers":[{"name":"Ada Lovelace","email":"ada@example.com"}],"fields":[{"signer":0,"kind":"signature","page":0,"x":0.1,"y":0.8,"w":0.3,"h":0.06}]}},"SignatureUploaded":{"type":"object","properties":{"id":{"type":"string","description":"Signature request id (draft)."},"pages":{"type":"integer","description":""},"sha256":{"type":"string","description":"Hash of the original PDF."},"pageSizes":{"type":"array","items":{"type":"object","properties":{"w":{"type":"number"},"h":{"type":"number"}}}}}},"SignatureRequest":{"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":"string","description":""},"status":{"type":"string","description":"","enum":["draft","sent","completed","declined","cancelled","expired"]},"file_name":{"type":"string","description":""},"pages":{"type":"integer","description":""},"created_at":{"type":"string","format":"date-time"},"sent_at":{"type":["string","null"],"format":"date-time","description":""},"completed_at":{"type":["string","null"],"format":"date-time","description":""},"expires_at":{"type":["string","null"],"format":"date-time","description":""},"delete_after":{"type":["string","null"],"format":"date-time","description":""},"downloadable":{"type":"boolean","description":"The signed PDF can be downloaded."},"signers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"email":{"type":"string","description":""},"status":{"type":"string","description":""}}}}}},"SignatureDetail":{"type":"object","properties":{"request":{"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":"string","description":""},"message":{"type":["string","null"]},"file_name":{"type":"string","description":""},"pages":{"type":"integer","description":""},"status":{"type":"string","description":""},"lang":{"type":"string","description":""},"original_sha256":{"type":"string","description":""},"final_sha256":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"sent_at":{"type":["string","null"],"format":"date-time","description":""},"completed_at":{"type":["string","null"],"format":"date-time","description":""},"expires_at":{"type":["string","null"],"format":"date-time","description":""},"delete_after":{"type":["string","null"],"format":"date-time","description":""},"files_deleted":{"type":"boolean","description":""}}},"signers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":""},"ord":{"type":"integer","description":""},"name":{"type":"string","description":""},"email":{"type":"string","description":""},"status":{"type":"string","description":""},"viewed_at":{"type":["string","null"],"format":"date-time","description":""},"signed_at":{"type":["string","null"],"format":"date-time","description":""},"declined_at":{"type":["string","null"],"format":"date-time","description":""},"decline_reason":{"type":["string","null"]},"last_reminded_at":{"type":["string","null"],"format":"date-time","description":""}}}},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":""},"signer":{"type":"integer","description":""},"kind":{"type":"string","description":""},"page":{"type":"integer","description":""},"x":{"type":"number"},"y":{"type":"number"},"w":{"type":"number"},"h":{"type":"number"},"required":{"type":"boolean","description":""},"filled":{"type":"boolean","description":""},"value":{"type":"string","description":"Text value, or the dashboard image path for signatures."}}}},"events":{"type":"array","items":{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"kind":{"type":"string","description":""},"signer":{"type":["integer","null"]}}}},"usage":{"type":"object","properties":{"used":{"type":"integer","description":"Requests sent this month."},"limit":{"type":"integer","description":""},"plan":{"type":"string","description":""}}}}},"Branding":{"type":"object","properties":{"pro":{"type":"boolean","description":""},"paid":{"type":"boolean","description":""},"teamManaged":{"type":"boolean","description":"Members of a team see the owner's branding read-only."},"name":{"type":"string","description":"Sender / brand name."},"color":{"type":"string","description":"Accent colour #RRGGBB (Pro)."},"logo":{"type":["string","null"],"description":"Path of the logo image."},"bg":{"type":["string","null"],"description":"Path of the background image (Pro)."}}},"BrandingUpdate":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Up to 60 characters."},"color":{"type":["string","null"],"description":"#RRGGBB."}},"example":{"name":"Studio Nord","color":"#1F7A4D"}},"Team":{"type":"object","properties":{"team":{"type":"object","properties":{"id":{"type":"string","description":""},"name":{"type":["string","null"]},"seats":{"type":"integer","description":""},"used":{"type":"integer","description":""},"pending":{"type":"integer","description":"Open invites."},"active":{"type":"boolean","description":"Team subscription active."},"owner":{"type":"object","properties":{"email":{"type":"string","description":""},"name":{"type":["string","null"]}}}}},"role":{"type":"string","description":"","enum":["owner"]},"members":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}},"invites":{"type":"array","items":{"$ref":"#/components/schemas/TeamInvite"}}}},"TeamMember":{"type":"object","properties":{"userId":{"type":"string","description":""},"email":{"type":"string","description":""},"name":{"type":["string","null"]},"role":{"type":"string","description":"","enum":["owner","member"]},"joined_at":{"type":"string","format":"date-time"},"sent30":{"type":"integer","description":"Transfers this month."},"bytes30":{"type":"integer","description":"Bytes this month."}}},"TeamInvite":{"type":"object","properties":{"id":{"type":"integer","description":""},"email":{"type":"string","description":""},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"expired":{"type":"boolean","description":""}}},"TeamInviteCreate":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","description":"","format":"email"},"description":"1–10 addresses; each gets an email with a join link."}},"required":["emails"],"example":{"emails":["sam@example.com"]}},"Event":{"type":"object","properties":{"id":{"type":"string","description":"evt_…"},"type":{"type":"string","description":"","enum":["transfer.ready","transfer.downloaded","transfer.expired","approval.created","request.upload","signature.completed"]},"created":{"type":"integer","description":"Unix seconds."},"livemode":{"type":"boolean","description":"false for events about test-mode transfers."},"data":{"type":"object","description":"Event payload (see the webhooks guide)."}}},"Hook":{"type":"object","properties":{"id":{"type":"integer","description":""},"url":{"type":"string","description":""},"events":{"type":"array","items":{"type":"string","description":""}},"all_downloads":{"type":"boolean","description":"Every download, not only the first per recipient."},"source":{"type":"string","description":""},"status":{"type":"string","description":"","enum":["active","failing","disabled"]},"created_at":{"type":"string","format":"date-time"}}},"HookCreate":{"type":"object","properties":{"url":{"type":"string","description":"https URL that receives the events (Zapier: target_url)."},"target_url":{"type":"string","description":"Alias of url."},"events":{"type":"array","items":{"type":"string","description":""},"description":"Event types."},"event":{"type":"string","description":"One event type (alias)."},"all_downloads":{"type":"boolean","description":""},"description":{"type":"string","description":""}},"example":{"url":"https://example.com/pandafile-webhook","events":["transfer.ready","transfer.downloaded"]}},"HookCreated":{"type":"object","properties":{"id":{"type":"integer","description":""},"url":{"type":"string","description":""},"events":{"type":"array","items":{"type":"string","description":""}},"all_downloads":{"type":"boolean","description":""},"secret":{"type":"string","description":"whsec_… signing secret, shown once."},"created_at":{"type":"string","format":"date-time"}}}}},"x-pandafile-versions":{"2025-06-01":"The original API. Errors are {\"error\": \"<message>\"} (in the language of Accept-Language). Lists that existed then keep their keys (GET /transfers → transfers + next, GET /hooks → hooks, GET /events → events) with has_more and next_cursor added. POST /transfers answers 200.","2026-11-27":"Errors are {\"error\": {\"type\", \"code\", \"message\", \"param\"?}} with English messages. Every list is {\"object\": \"list\", \"data\": [...], \"has_more\", \"next_cursor\"}. Creating anything answers 201."},"x-pandafile-error-types":{"invalid_request_error":"The request was wrong: a missing or invalid parameter, an unknown id, or a state that does not allow it.","authentication_error":"No API key, or the key is unknown, revoked or malformed.","permission_error":"The key is valid but may not do this (plan, key scope, test mode, team role).","idempotency_error":"The Idempotency-Key was used before with a different request, or that request is still running.","rate_limit_error":"Too many requests for this key. Wait Retry-After seconds.","api_error":"Something went wrong on our side. Safe to retry with the same Idempotency-Key."}}