Some filters are restricted based on the authentication method used or permissions of the organization member.To filter packages for other members, you must use one of the following authentication methods:
Organization API Key
User API Key with Sign Editor or Package Editor role enabled
Organization OAuth App
To filter packages for teams, the authenticated member must belong to the specified team.
This performs a full text search on package name, description, message, category, client number, matter number, as well as signer and recipient first name, last name, email, and mobile number.
You can use * as a wildcard character to perform suffix matching (e.g., Contract* matches any package whose name contains a word starting with “Contract”).
Concurrent: Allows multiple signers to sign the document simultaneously.
Sequential
Sequential: Requires signers to sign the document in a specific order.
Counterpart
Group Send: Enables group signing, where all signers receive the document at the same time.
video_closing_room
Video Signing Room: A virtual room for signing documents via video conference.
Live Session
In Person: An in-person signing session with all parties present.
Even though the signing workflow names have evolved, the constants used to identify them have remained the same.
The package type constants are case-sensitive. Ensure that you use the exact casing as shown in the table above when specifying package types in your API requests.
New package states may be added in future releases. It is recommended that you always validate your integration against the sandbox before new releases are deployed into production.
Release 4.0 introduces two new package states, executed and expired. In 3.6 both executed and expired packages were in an open state.
Value
Version
Description
draft
1.0
Package will be added in a draft state. Notifications will not be sent to the signer(s). You must call the send API, or the package owner must manually send the package from within iinked Sign.
open
1.0
The package will be ready for signing, and notifications will be sent to the signer(s) if enabled.
executed
4.0
The package has been fully executed by all signers.
expired
4.0
The package was not signed by the sign by date and has now expired. VSR packages will expire 7 days after their scheduled meeting date.
rescinded
3.5
The package was rescinded and is no longer available for signing.
select
3.6
Use the select state only when the package will be opened in the embedded package editor and you want the workflow to prompt the user to choose a package type. Packages in the select state will be automatically deleted if not converted to draft or open within 24 hours.
add
2.9
Use the add state only when the package will be opened in the embedded package editor and you want the workflow to function as if you’re creating a new package, rather than editing an existing one. Packages in the add state will be automatically deleted if not converted to draft or open within 24 hours.
Concurrent: Allows multiple signers to sign the document simultaneously.
Sequential
Sequential: Requires signers to sign the document in a specific order.
Counterpart
Group Send: Enables group signing, where all signers receive the document at the same time.
video_closing_room
Video Signing Room: A virtual room for signing documents via video conference.
Live Session
In Person: An in-person signing session with all parties present.
Even though the signing workflow names have evolved, the constants used to identify them have remained the same.
The package type constants are case-sensitive. Ensure that you use the exact casing as shown in the table above when specifying package types in your API requests.
New package states may be added in future releases. It is recommended that you always validate your integration against the sandbox before new releases are deployed into production.
Release 4.0 introduces two new package states, executed and expired. In 3.6 both executed and expired packages were in an open state.
Value
Version
Description
draft
1.0
Package will be added in a draft state. Notifications will not be sent to the signer(s). You must call the send API, or the package owner must manually send the package from within iinked Sign.
open
1.0
The package will be ready for signing, and notifications will be sent to the signer(s) if enabled.
executed
4.0
The package has been fully executed by all signers.
expired
4.0
The package was not signed by the sign by date and has now expired. VSR packages will expire 7 days after their scheduled meeting date.
rescinded
3.5
The package was rescinded and is no longer available for signing.
select
3.6
Use the select state only when the package will be opened in the embedded package editor and you want the workflow to prompt the user to choose a package type. Packages in the select state will be automatically deleted if not converted to draft or open within 24 hours.
add
2.9
Use the add state only when the package will be opened in the embedded package editor and you want the workflow to function as if you’re creating a new package, rather than editing an existing one. Packages in the add state will be automatically deleted if not converted to draft or open within 24 hours.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"iinked Sign","description":"This repository contains the official documentation for the iinked Sign API, providing comprehensive guides, reference materials, and best practices for developers and integrators working with iinked Sign platform.","colors":{"primary":"#7614FF","light":"#F5F5F5","dark":"#7614FF"},"logo":{"light":"https://mintcdn.com/syngrafiiinc/_k0NRRGysMSfLRzj/assets/logo.svg?fit=max\u0026auto=format\u0026n=_k0NRRGysMSfLRzj\u0026q=85\u0026s=979273c306b7b05ff3ca16660db67744","dark":"https://mintcdn.com/syngrafiiinc/_k0NRRGysMSfLRzj/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=_k0NRRGysMSfLRzj\u0026q=85\u0026s=c33268df5f15d60a6a2873c3c50b429e"},"favicon":{"light":"https://mintcdn.com/syngrafiiinc/pbkUy3Y4RGnQsvQI/assets/favicon.ico?fit=max\u0026auto=format\u0026n=pbkUy3Y4RGnQsvQI\u0026q=85\u0026s=aa2c76b36ed6f74a221741e472aacb3d","dark":"https://mintcdn.com/syngrafiiinc/pbkUy3Y4RGnQsvQI/assets/favicon.ico?fit=max\u0026auto=format\u0026n=pbkUy3Y4RGnQsvQI\u0026q=85\u0026s=aa2c76b36ed6f74a221741e472aacb3d"},"api":{"playground":{"display":"simple"},"examples":{"defaults":"required"},"mdx":{"auth":{"method":"key","name":"api_key"},"server":["https://sandbox.syngrafii.com/api/v1","https://sandbox.syngrafii.eu/api/v1","https://sign.syngrafii.com/api/v1","https://sign.syngrafii.ca/api/v1","https://sign.syngrafii.eu/api/v1"]}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"icon":"circle-question","href":"https://support.syngrafii.com","label":"Support"},{"icon":"user","href":"https://iinkedsign.com/login","label":"Log in"}]},"footer":{"socials":{"x":"https://x.com/syngrafii","linkedin":"https://www.linkedin.com/company/syngrafii-inc-"},"links":[{"header":"Resources","items":[{"label":"Request Demo","href":"https://iinkedsign.com/demo"},{"label":"Start Free Trial","href":"https://iinkedsign.com/start-trial"},{"label":"Support","href":"https://support.syngrafii.com"}]},{"header":"Company","items":[{"label":"About Us","href":"https://syngrafii.com/about"},{"label":"Privacy Policy","href":"https://iinkedsign.com/privacy-policy"},{"label":"Terms of Use","href":"https://iinkedsign.com/terms-of-use"}]}]},"seo":{"metatags":{"canonical":"https://docs.iinkedsign.com"}},"integrations":{"ga4":{"measurementId":"G-9TWCM1Y4DS"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"syngrafiiinc","hasAudioNarration":false,"actualSubdomain":"syngrafiiinc","customDomains":["docs.iinkedsign.com"],"gitSource":{"type":"github","owner":"iinkedsign","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abad61c1c6d3fe019da47ba","collectionId":"0c8d2dcf-7c19-417b-bf43-094d82543414","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abad61c1c6d3fe019da47ba"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6abad61c1c6d3fe019da47ba","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":121},{"language":"default","tag":"Reference","count":53},{"language":"default","tag":"API","count":24},{"language":"default","tag":"Guides","count":22},{"language":"default","tag":"Packages","count":17},{"language":"default","tag":"Webhooks","count":17},{"language":"default","tag":"Events","count":16},{"language":"default","tag":"Package options","count":13},{"language":"default","tag":"Verifications","count":12},{"language":"default","tag":"Template Tagging","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v4/api/packages/list","slug":"/v4/api/packages/list","pageMetadata":{"title":"List","api":"POST /packages/list","description":null,"href":"/v4/api/packages/list"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,Note,ParamField,ResponseField,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`You can retrieve a list of an organization members’ current packages by calling the `,_jsx(_components.code,{children:`packages/list`}),` endpoint.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(CodeBlock,{filename:`Request`,numberOfLines:`11`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /packages/list`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"memberId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"e4f0bce5-30fc-43c4-b9ee-364ff5b04dea\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"search\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"types\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"states\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isExecuted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sortBy\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"created\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"take\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"skip\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`body`,children:`Body`}),`\n`,_jsxs(Note,{children:[_jsx(_components.p,{children:`Some filters are restricted based on the authentication method used or permissions of the organization member.`}),_jsx(_components.p,{children:`To filter packages for other members, you must use one of the following authentication methods:`}),_jsxs(`ul`,{children:[_jsx(`li`,{children:`Organization API Key`}),_jsxs(`li`,{children:[`User API Key with `,_jsx(_components.code,{children:`Sign Editor`}),` or `,_jsx(_components.code,{children:`Package Editor`}),` role enabled`]}),_jsx(`li`,{children:`Organization OAuth App`})]}),_jsx(_components.p,{children:`To filter packages for teams, the authenticated member must belong to the specified team.`})]}),`\n`,_jsx(ParamField,{body:`memberId`,type:`string`,id:`param-member-id`,children:_jsx(_components.p,{children:`The member ID to retrieve packages for.`})}),`\n`,_jsx(ParamField,{body:`teamId`,type:`string`,id:`param-team-id`,children:_jsx(_components.p,{children:`The team ID to retrieve packages for.`})}),`\n`,_jsx(ParamField,{body:`folderId`,type:`string`,id:`param-folder-id`,children:_jsx(_components.p,{children:`Filter packages by folder ID.`})}),`\n`,_jsx(ParamField,{body:`allMembers`,type:`boolean`,id:`param-all-members`,children:_jsx(_components.p,{children:`When true, retrieves packages for all members in the organization.`})}),`\n`,_jsxs(ParamField,{body:`search`,type:`string`,id:`param-search`,children:[_jsx(_components.p,{children:`Filter packages by search terms.`}),_jsx(Note,{children:_jsxs(_components.p,{children:[`This performs a full text search on package `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`description`}),`, `,_jsx(_components.code,{children:`message`}),`, `,_jsx(_components.code,{children:`category`}),`, `,_jsx(_components.code,{children:`client number`}),`, `,_jsx(_components.code,{children:`matter number`}),`, as well as signer and recipient `,_jsx(_components.code,{children:`first name`}),`, `,_jsx(_components.code,{children:`last name`}),`, `,_jsx(_components.code,{children:`email`}),`, and `,_jsx(_components.code,{children:`mobile number`}),`.\nYou can use `,_jsx(_components.code,{children:`*`}),` as a wildcard character to perform suffix matching (e.g., `,_jsx(_components.code,{children:`Contract*`}),` matches any package whose name contains a word starting with “Contract”).`]})})]}),`\n`,_jsxs(ParamField,{body:`types`,type:`string[]`,id:`param-types`,children:[_jsx(_components.p,{children:`Filter packages by package type.`}),_jsxs(Expandable,{title:`values`,children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`concurrent`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Concurrent`}),`: Allows multiple signers to sign the document simultaneously.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Sequential`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Sequential`}),`: Requires signers to sign the document in a specific order.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Counterpart`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Group Send`}),`: Enables group signing, where all signers receive the document at the same time.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`video_closing_room`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Video Signing Room`}),`: A virtual room for signing documents via video conference.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Live Session`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`In Person`}),`: An in-person signing session with all parties present.`]})]})]})]}),_jsx(Note,{children:_jsx(_components.p,{children:`Even though the signing workflow names have evolved, the constants used to identify them have remained the same.`})}),_jsx(Tip,{children:_jsx(_components.p,{children:`The package type constants are case-sensitive. Ensure that you use the exact casing as shown in the table above when specifying package types in your API requests.`})})]})]}),`\n`,_jsxs(ParamField,{body:`states`,type:`string[]`,id:`param-states`,children:[_jsx(_components.p,{children:`Filter packages by package state.`}),_jsxs(Expandable,{title:`values`,children:[_jsx(Tip,{children:_jsx(_components.p,{children:`New package states may be added in future releases. It is recommended that you always validate your integration against the sandbox before new releases are deployed into production.`})}),_jsx(Note,{children:_jsxs(_components.p,{children:[`Release 4.0 introduces two new package states, `,_jsx(_components.code,{children:`executed`}),` and `,_jsx(_components.code,{children:`expired`}),`. In 3.6 both executed and expired packages were in an `,_jsx(_components.code,{children:`open`}),` state.`]})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Version`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`draft`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`1.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Package will be added in a draft state. Notifications will not be sent to the signer(s). You must call the send API, or the package owner must manually send the package from within iinked Sign.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`open`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`1.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package will be ready for signing, and notifications will be sent to the signer(s) if enabled.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`executed`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`4.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package has been fully executed by all signers.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`expired`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`4.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package was not signed by the sign by date and has now expired. VSR packages will expire 7 days after their scheduled meeting date.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`rescinded`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`3.5`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package was rescinded and is no longer available for signing.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`select`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`3.6`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Use the select state only when the package will be opened in the `,_jsx(_components.strong,{children:`embedded package editor`}),` and you want the workflow to prompt the user to choose a package type. Packages in the select state will be automatically deleted if not converted to draft or open within 24 hours.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`add`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`2.9`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Use the add state only when the package will be opened in the `,_jsx(_components.strong,{children:`embedded package editor`}),` and you want the workflow to function as if you’re creating a new package, rather than editing an existing one. Packages in the add state will be automatically deleted if not converted to draft or open within 24 hours.`]})]})]})]})]})]}),`\n`,_jsx(ParamField,{body:`isExecuted`,type:`boolean`,id:`param-is-executed`,children:_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`true`}),` will only return executed packages, when `,_jsx(_components.code,{children:`false`}),` will only return non-executed packages. Leave null to not apply any executed filter.`]})}),`\n`,_jsxs(ParamField,{body:`days`,type:`number`,max:365,id:`param-days`,children:[_jsx(_components.p,{children:`Filter packages whose sign by date is within the next X days.`}),_jsx(Note,{children:_jsxs(_components.p,{children:[`For example, setting `,_jsx(_components.code,{children:`days`}),` to `,_jsx(_components.code,{children:`7`}),` will return packages whose sign by date is within the next 7 days.`]})}),_jsx(Tip,{children:_jsx(_components.p,{children:`You can use a negative value to filter packages whose sign by date is in the past.`})})]}),`\n`,_jsxs(ParamField,{body:`sortBy`,type:`string`,default:`created`,id:`param-sort-by`,children:[_jsx(_components.p,{children:`Sort results by one of the following:`}),_jsx(Expandable,{title:`values`,defaultOpen:true,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`created`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Date package was created (descending).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`last_modified`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Date package was last modified (descending).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`reminder`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Date of scheduled reminder (descending).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`signed`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Date package was signed by last signer (descending).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`sign_by`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Date package is to be signed by (descending).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`sign_by_ascending`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Date package is to be signed by (ascending).`})]})]})]})})]}),`\n`,_jsx(ParamField,{body:`take`,type:`number`,max:100,default:50,id:`param-take`,children:_jsx(_components.p,{children:`Number of packages to return.`})}),`\n`,_jsx(ParamField,{body:`skip`,type:`number`,id:`param-skip`,children:_jsx(_components.p,{children:`Number of packages to skip. Used for pagination or infinite scroll.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(ResponseField,{name:`items`,type:`object[]`,id:`param-items`,children:[_jsx(_components.p,{children:`Array of packages returned.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`packageId`,type:`string`,id:`param-package-id`,children:_jsx(_components.p,{children:`Unique identifier for the package.`})}),_jsx(ResponseField,{name:`organizationId`,type:`string`,id:`param-organization-id`,children:_jsx(_components.p,{children:`Unique identifier for the organization that owns the package.`})}),_jsx(ResponseField,{name:`memberId`,type:`string`,id:`param-member-id-1`,children:_jsx(_components.p,{children:`Identifier for the member who created/owns the package.`})}),_jsx(ResponseField,{name:`teamId`,type:`string`,post:[`nullable`],id:`param-team-id-1`,children:_jsx(_components.p,{children:`Team identifier associated with the package. (optional)`})}),_jsx(ResponseField,{name:`folderId`,type:`string`,post:[`nullable`],id:`param-folder-id-1`,children:_jsx(_components.p,{children:`Folder identifier where the package is stored. (optional)`})}),_jsx(ResponseField,{name:`shared`,type:`boolean`,id:`param-shared`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if the package is shared.`]})}),_jsx(ResponseField,{name:`timeCreated`,type:`string`,id:`param-time-created`,children:_jsx(_components.p,{children:`Creation time (ISO 8601 date-time).`})}),_jsx(ResponseField,{name:`timeLastModified`,type:`string`,id:`param-time-last-modified`,children:_jsx(_components.p,{children:`Last modification time (ISO 8601 date-time).`})}),_jsx(ResponseField,{name:`timeSignBy`,type:`string`,id:`param-time-sign-by`,children:_jsx(_components.p,{children:`Deadline for signing (ISO 8601 date-time).`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Display name of the package.`})}),_jsx(ResponseField,{name:`category`,type:`string`,post:[`nullable`],id:`param-category`,children:_jsx(_components.p,{children:`Category for the package. (optional)`})}),_jsx(ResponseField,{name:`clientNumber`,type:`string`,post:[`nullable`],id:`param-client-number`,children:_jsx(_components.p,{children:`Client reference number. (optional)`})}),_jsx(ResponseField,{name:`matterNumber`,type:`string`,post:[`nullable`],id:`param-matter-number`,children:_jsx(_components.p,{children:`Matter reference number. (optional)`})}),_jsx(ResponseField,{name:`description`,type:`string`,post:[`nullable`],id:`param-description`,children:_jsx(_components.p,{children:`Description of the package. (optional)`})}),_jsxs(ResponseField,{name:`type`,type:`string`,id:`param-type`,children:[_jsx(_components.p,{children:`Package type identifier.`}),_jsxs(Expandable,{title:`values`,children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`concurrent`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Concurrent`}),`: Allows multiple signers to sign the document simultaneously.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Sequential`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Sequential`}),`: Requires signers to sign the document in a specific order.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Counterpart`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Group Send`}),`: Enables group signing, where all signers receive the document at the same time.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`video_closing_room`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`Video Signing Room`}),`: A virtual room for signing documents via video conference.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`Live Session`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[_jsx(_components.strong,{children:`In Person`}),`: An in-person signing session with all parties present.`]})]})]})]}),_jsx(Note,{children:_jsx(_components.p,{children:`Even though the signing workflow names have evolved, the constants used to identify them have remained the same.`})}),_jsx(Tip,{children:_jsx(_components.p,{children:`The package type constants are case-sensitive. Ensure that you use the exact casing as shown in the table above when specifying package types in your API requests.`})})]})]}),_jsxs(ResponseField,{name:`state`,type:`string`,id:`param-state`,children:[_jsx(_components.p,{children:`Current state of the package.`}),_jsxs(Expandable,{title:`values`,children:[_jsx(Tip,{children:_jsx(_components.p,{children:`New package states may be added in future releases. It is recommended that you always validate your integration against the sandbox before new releases are deployed into production.`})}),_jsx(Note,{children:_jsxs(_components.p,{children:[`Release 4.0 introduces two new package states, `,_jsx(_components.code,{children:`executed`}),` and `,_jsx(_components.code,{children:`expired`}),`. In 3.6 both executed and expired packages were in an `,_jsx(_components.code,{children:`open`}),` state.`]})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Version`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`draft`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`1.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Package will be added in a draft state. Notifications will not be sent to the signer(s). You must call the send API, or the package owner must manually send the package from within iinked Sign.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`open`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`1.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package will be ready for signing, and notifications will be sent to the signer(s) if enabled.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`executed`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`4.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package has been fully executed by all signers.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`expired`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`4.0`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package was not signed by the sign by date and has now expired. VSR packages will expire 7 days after their scheduled meeting date.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`rescinded`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`3.5`}),_jsx(_components.td,{style:{textAlign:`left`},children:`The package was rescinded and is no longer available for signing.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`select`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`3.6`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Use the select state only when the package will be opened in the `,_jsx(_components.strong,{children:`embedded package editor`}),` and you want the workflow to prompt the user to choose a package type. Packages in the select state will be automatically deleted if not converted to draft or open within 24 hours.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`add`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`2.9`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Use the add state only when the package will be opened in the `,_jsx(_components.strong,{children:`embedded package editor`}),` and you want the workflow to function as if you’re creating a new package, rather than editing an existing one. Packages in the add state will be automatically deleted if not converted to draft or open within 24 hours.`]})]})]})]})]})]}),_jsx(ResponseField,{name:`externalData`,type:`Map\u003cstring, object>`,post:[`nullable`],id:`param-external-data`,children:_jsx(_components.p,{children:`Arbitrary external data attached to the package.`})}),_jsxs(ResponseField,{name:`documents`,type:`object[]`,id:`param-documents`,children:[_jsx(_components.p,{children:`Documents that belong to the package.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`documentId`,type:`string`,id:`param-document-id`,children:_jsx(_components.p,{children:`Unique identifier for the document.`})}),_jsx(ResponseField,{name:`externalId`,type:`string`,post:[`nullable`],id:`param-external-id`,children:_jsx(_components.p,{children:`External identifier for the document. (optional)`})}),_jsx(ResponseField,{name:`index`,type:`number`,id:`param-index`,children:_jsx(_components.p,{children:`Order/index of the document within the package.`})}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:_jsx(_components.p,{children:`Document display name.`})}),_jsx(ResponseField,{name:`fileName`,type:`string`,id:`param-file-name`,children:_jsx(_components.p,{children:`Original filename uploaded.`})}),_jsx(ResponseField,{name:`isExecuted`,type:`boolean`,id:`param-is-executed-1`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if the document has been executed.`]})}),_jsx(ResponseField,{name:`timeExecuted`,type:`string`,post:[`nullable`],id:`param-time-executed`,children:_jsx(_components.p,{children:`Execution time (ISO 8601 date-time).`})})]})]}),_jsxs(ResponseField,{name:`signers`,type:`object[]`,id:`param-signers`,children:[_jsx(_components.p,{children:`Signers for the package.`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`signerId`,type:`string`,id:`param-signer-id`,children:_jsx(_components.p,{children:`Unique identifier for the signer.`})}),_jsx(ResponseField,{name:`index`,type:`number`,id:`param-index-1`,children:_jsx(_components.p,{children:`Signing order index.`})}),_jsx(ResponseField,{name:`firstName`,type:`string`,id:`param-first-name`,children:_jsx(_components.p,{children:`First name of the signer.`})}),_jsx(ResponseField,{name:`lastName`,type:`string`,id:`param-last-name`,children:_jsx(_components.p,{children:`Last name of the signer.`})}),_jsx(ResponseField,{name:`email`,type:`string`,id:`param-email`,children:_jsx(_components.p,{children:`Email address of the signer.`})}),_jsxs(ResponseField,{name:`role`,type:`string`,id:`param-role`,children:[_jsx(_components.p,{children:`Role of the signer.`}),_jsx(Expandable,{title:`values`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`signer`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Signer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`guest`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Guest of VSR or In Person signing that is not a signer of any documents`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`host`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Host of VSR or In Person signing`})]})]})]})})]}),_jsxs(ResponseField,{name:`type`,type:`string`,id:`param-type-1`,children:[_jsx(_components.p,{children:`Type of the signer.`}),_jsx(Expandable,{title:`values`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`signer`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Signer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`guest`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Signer that was added by the host during VSR or In Person signing session`})]})]})]})})]}),_jsx(ResponseField,{name:`verify`,type:`boolean`,id:`param-verify`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if signer requires identity verification before signing.`]})}),_jsx(ResponseField,{name:`isVerified`,type:`boolean`,id:`param-is-verified`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if the signer has been verified.`]})}),_jsx(ResponseField,{name:`isNext`,type:`boolean`,id:`param-is-next`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if the signer is the next in line to sign.`]})}),_jsx(ResponseField,{name:`isExecuted`,type:`boolean`,id:`param-is-executed-2`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if the signer has executed all documents in the signing package.`]})}),_jsx(ResponseField,{name:`timeExecuted`,type:`string`,post:[`nullable`],id:`param-time-executed-1`,children:_jsx(_components.p,{children:`Execution time (ISO 8601 date-time).`})})]})]}),_jsxs(ResponseField,{name:`recipients`,type:`object[]`,id:`param-recipients`,children:[_jsx(_components.p,{children:`Recipients related to the package (additional recipients beyond signers).`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`recipientId`,type:`string`,id:`param-recipient-id`,children:_jsx(_components.p,{children:`Unique identifier for the recipient.`})}),_jsx(ResponseField,{name:`firstName`,type:`string`,id:`param-first-name-1`,children:_jsx(_components.p,{children:`Recipient first name.`})}),_jsx(ResponseField,{name:`lastName`,type:`string`,id:`param-last-name-1`,children:_jsx(_components.p,{children:`Recipient last name.`})}),_jsx(ResponseField,{name:`email`,type:`string`,id:`param-email-1`,children:_jsx(_components.p,{children:`Recipient email address.`})}),_jsxs(ResponseField,{name:`type`,type:`string`,id:`param-type-2`,children:[_jsx(_components.p,{children:`Recipient type.`}),_jsx(Expandable,{title:`values`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Value`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`cc`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Recipient that will be `,_jsx(_components.strong,{children:`CC`}),` on package email notifications.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{style:{textAlign:`left`},children:`bcc`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`Recipient that will be `,_jsx(_components.strong,{children:`BCC`}),` on package email notifications.`]})]})]})]})})]})]})]}),_jsx(ResponseField,{name:`isExecuted`,type:`boolean`,id:`param-is-executed-3`,children:_jsxs(_components.p,{children:[`Set to `,_jsx(_components.code,{children:`true`}),` if the package has been executed.`]})}),_jsx(ResponseField,{name:`timeExecuted`,type:`string`,post:[`nullable`],id:`param-time-executed-2`,children:_jsx(_components.p,{children:`Execution time (ISO 8601 date-time).`})})]})]}),`\n`,_jsx(ResponseField,{name:`total`,type:`number`,id:`param-total`,children:_jsx(_components.p,{children:`Total number of packages that match filter criteria.`})}),`\n`,_jsx(ResponseField,{name:`take`,type:`number`,id:`param-take-1`,children:_jsx(_components.p,{children:`Number of packages returned per request.`})}),`\n`,_jsx(ResponseField,{name:`skip`,type:`number`,id:`param-skip-1`,children:_jsx(_components.p,{children:`Number of packages skipped.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List","api":"POST /packages/list","description":null,"href":"/v4/api/packages/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":2,"children":[{"title":"Body","slug":"body","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"List","path":"/packages/list","servers":[{"url":"https://sandbox.syngrafii.com/api/v1"},{"url":"https://sandbox.syngrafii.eu/api/v1"},{"url":"https://sign.syngrafii.com/api/v1"},{"url":"https://sign.syngrafii.ca/api/v1"},{"url":"https://sign.syngrafii.eu/api/v1"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"api_key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"memberId":[{"type":"string","description":"The member ID to retrieve packages for."}],"teamId":[{"type":"string","description":"The team ID to retrieve packages for."}],"folderId":[{"type":"string","description":"Filter packages by folder ID."}],"allMembers":[{"type":"boolean","description":"When true, retrieves packages for all members in the organization."}],"search":[{"type":"string","description":"Filter packages by search terms."}],"types":[{"type":"array","items":[{"type":"string"}],"description":"Filter packages by package type."}],"states":[{"type":"array","items":[{"type":"string"}],"description":"Filter packages by package state."}],"isExecuted":[{"type":"boolean","description":"When `true` will only return executed packages, when `false` will only return non-executed packages. Leave null to not apply any executed filter."}],"days":[{"type":"number","description":"Filter packages whose sign by date is within the next X days."}],"sortBy":[{"type":"string","description":"Sort results by one of the following:"}],"take":[{"type":"number","description":"Number of packages to return."}],"skip":[{"type":"number","description":"Number of packages to skip. Used for pagination or infinite scroll."}]}}],"examples":{"example":{"value":{"memberId":"\u003cstring>","teamId":"\u003cstring>","folderId":"\u003cstring>","allMembers":true,"search":"\u003cstring>","types":["\u003cstring>"],"states":["\u003cstring>"],"isExecuted":true,"days":123,"sortBy":"\u003cstring>","take":123,"skip":123}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"items":[{"type":"array","items":[{"type":"object","properties":{"packageId":[{"type":"string","description":"Unique identifier for the package."}],"organizationId":[{"type":"string","description":"Unique identifier for the organization that owns the package."}],"memberId":[{"type":"string","description":"Identifier for the member who created/owns the package."}],"teamId":[{"type":"string","description":"Team identifier associated with the package. (optional)"}],"folderId":[{"type":"string","description":"Folder identifier where the package is stored. (optional)"}],"shared":[{"type":"boolean","description":"Set to `true` if the package is shared."}],"timeCreated":[{"type":"string","description":"Creation time (ISO 8601 date-time)."}],"timeLastModified":[{"type":"string","description":"Last modification time (ISO 8601 date-time)."}],"timeSignBy":[{"type":"string","description":"Deadline for signing (ISO 8601 date-time)."}],"name":[{"type":"string","description":"Display name of the package."}],"category":[{"type":"string","description":"Category for the package. (optional)"}],"clientNumber":[{"type":"string","description":"Client reference number. (optional)"}],"matterNumber":[{"type":"string","description":"Matter reference number. (optional)"}],"description":[{"type":"string","description":"Description of the package. (optional)"}],"type":[{"type":"string","description":"Package type identifier."}],"state":[{"type":"string","description":"Current state of the package."}],"externalData":[{"type":"object","properties":{},"description":"Arbitrary external data attached to the package."}],"documents":[{"type":"array","items":[{"type":"object","properties":{"documentId":[{"type":"string","description":"Unique identifier for the document."}],"externalId":[{"type":"string","description":"External identifier for the document. (optional)"}],"index":[{"type":"number","description":"Order/index of the document within the package."}],"name":[{"type":"string","description":"Document display name."}],"fileName":[{"type":"string","description":"Original filename uploaded."}],"isExecuted":[{"type":"boolean","description":"Set to `true` if the document has been executed."}],"timeExecuted":[{"type":"string","description":"Execution time (ISO 8601 date-time)."}]}}],"description":"Documents that belong to the package."}],"signers":[{"type":"array","items":[{"type":"object","properties":{"signerId":[{"type":"string","description":"Unique identifier for the signer."}],"index":[{"type":"number","description":"Signing order index."}],"firstName":[{"type":"string","description":"First name of the signer."}],"lastName":[{"type":"string","description":"Last name of the signer."}],"email":[{"type":"string","description":"Email address of the signer."}],"role":[{"type":"string","description":"Role of the signer."}],"type":[{"type":"string","description":"Type of the signer."}],"verify":[{"type":"boolean","description":"Set to `true` if signer requires identity verification before signing."}],"isVerified":[{"type":"boolean","description":"Set to `true` if the signer has been verified."}],"isNext":[{"type":"boolean","description":"Set to `true` if the signer is the next in line to sign."}],"isExecuted":[{"type":"boolean","description":"Set to `true` if the signer has executed all documents in the signing package."}],"timeExecuted":[{"type":"string","description":"Execution time (ISO 8601 date-time)."}]}}],"description":"Signers for the package."}],"recipients":[{"type":"array","items":[{"type":"object","properties":{"recipientId":[{"type":"string","description":"Unique identifier for the recipient."}],"firstName":[{"type":"string","description":"Recipient first name."}],"lastName":[{"type":"string","description":"Recipient last name."}],"email":[{"type":"string","description":"Recipient email address."}],"type":[{"type":"string","description":"Recipient type."}]}}],"description":"Recipients related to the package (additional recipients beyond signers)."}],"isExecuted":[{"type":"boolean","description":"Set to `true` if the package has been executed."}],"timeExecuted":[{"type":"string","description":"Execution time (ISO 8601 date-time)."}]}}],"description":"Array of packages returned."}],"total":[{"type":"number","description":"Total number of packages that match filter criteria."}],"take":[{"type":"number","description":"Number of packages returned per request."}],"skip":[{"type":"number","description":"Number of packages skipped."}]}}],"examples":{"example":{"value":{"items":[{"packageId":"\u003cstring>","organizationId":"\u003cstring>","memberId":"\u003cstring>","teamId":"\u003cstring>","folderId":"\u003cstring>","shared":true,"timeCreated":"\u003cstring>","timeLastModified":"\u003cstring>","timeSignBy":"\u003cstring>","name":"\u003cstring>","category":"\u003cstring>","clientNumber":"\u003cstring>","matterNumber":"\u003cstring>","description":"\u003cstring>","type":"\u003cstring>","state":"\u003cstring>","externalData":{},"documents":[{"documentId":"\u003cstring>","externalId":"\u003cstring>","index":123,"name":"\u003cstring>","fileName":"\u003cstring>","isExecuted":true,"timeExecuted":"\u003cstring>"}],"signers":[{"signerId":"\u003cstring>","index":123,"firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","role":"\u003cstring>","type":"\u003cstring>","verify":true,"isVerified":true,"isNext":true,"isExecuted":true,"timeExecuted":"\u003cstring>"}],"recipients":[{"recipientId":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","type":"\u003cstring>"}],"isExecuted":true,"timeExecuted":"\u003cstring>"}],"total":123,"take":123,"skip":123}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"syngrafiiinc","siteName":"iinked Sign","title":"List - iinked Sign","navMaps":{"firstHrefInVersion":{"4.x":{"href":"/v4/api/packages/list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-08T16:22:09.830Z","originalFileLocation":"v4/api/packages/list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"iinked Sign\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List - iinked Sign\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"iinked Sign\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.iinkedsign.com/v4/api/packages/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://syngrafiiinc.mintlify.app/_mintlify/api/og/v2?division=Packages\u0026amp;title=List\u0026amp;theme=51d2742c5b8f9baace1e66c7\u0026amp;signature=7002d3c7cb113524de327a8bd0821af426a865567dfcf768197ea43bf7a0b4db\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List - iinked Sign\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://syngrafiiinc.mintlify.app/_mintlify/api/og/v2?division=Packages\u0026amp;title=List\u0026amp;theme=51d2742c5b8f9baace1e66c7\u0026amp;signature=7002d3c7cb113524de327a8bd0821af426a865567dfcf768197ea43bf7a0b4db\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/syngrafiiinc/EYxp6_FoaYqOvoQc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"iinked Sign\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7614FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.iinkedsign.com/v4/api/packages/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v4/api/packages/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.iinkedsign.com/#organization\",\"name\":\"iinked Sign\",\"url\":\"https://docs.iinkedsign.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/syngrafiiinc/_k0NRRGysMSfLRzj/assets/logo.svg?fit=max\u0026auto=format\u0026n=_k0NRRGysMSfLRzj\u0026q=85\u0026s=979273c306b7b05ff3ca16660db67744\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.iinkedsign.com#website\",\"name\":\"iinked Sign\",\"url\":\"https://docs.iinkedsign.com\",\"publisher\":{\"@id\":\"https://docs.iinkedsign.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.iinkedsign.com/v4/api/packages/list#webpage\",\"url\":\"https://docs.iinkedsign.com/v4/api/packages/list\",\"name\":\"List\",\"dateModified\":\"2026-09-08T16:22:09.830Z\",\"isPartOf\":{\"@id\":\"https://docs.iinkedsign.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.iinkedsign.com/v4/api/packages/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.iinkedsign.com/v4/api/packages/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API\",\"item\":\"https://docs.iinkedsign.com/v4/api/packages/add\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Packages\",\"item\":\"https://docs.iinkedsign.com/v4/api/packages/add\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List\",\"item\":\"https://docs.iinkedsign.com/v4/api/packages/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.iinkedsign.com/v4/api/packages/list#apireference\",\"headline\":\"List\",\"name\":\"List\",\"url\":\"https://docs.iinkedsign.com/v4/api/packages/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.iinkedsign.com/v4/api/packages/list#webpage\"},\"dateModified\":\"2026-09-08T16:22:09.830Z\",\"publisher\":{\"@id\":\"https://docs.iinkedsign.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.iinkedsign.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"iinked Sign\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"iinked Sign","nav":{"global":null,"versions":[{"version":"4.x","tabs":[{"tab":"Documentation","icon":"book","pages":[{"group":"Getting started","pages":[{"title":"Introduction","icon":"hand-wave","href":"/v4/introduction"},{"title":"Quickstart","icon":"rocket-launch","href":"/v4/quickstart"},{"title":"Authentication","icon":"lock","href":"/v4/authentication"},{"title":"OAuth 2.0","icon":"key","href":"/v4/oauth"},{"title":"Sandbox","icon":"flask-vial","href":"/v4/sandbox"}]},{"group":"Guides","icon":"books","pages":[{"sidebarTitle":"Workflows","title":"Workflows","icon":"arrow-progress","href":"/v4/guides/workflows"},{"sidebarTitle":"Signing","title":"Signing","icon":"file-contract","href":"/v4/guides/sign"},{"sidebarTitle":"IDV","title":"Identity verification (IDV)","icon":"id-card","href":"/v4/guides/sign-idv"},{"sidebarTitle":"QES","title":"Qualified Electronic Signatures (QES)","icon":"file-signature","href":"/v4/guides/sign-qes"},{"sidebarTitle":"Links","title":"Links","icon":"link","href":"/v4/guides/sign-links"},{"sidebarTitle":"Webhooks","title":"Webhooks guide","icon":"share-nodes","href":"/v4/guides/webhooks"},{"group":"Embed","icon":"code","expanded":true,"pages":[{"sidebarTitle":"Signing","title":"Embed signing","icon":"file-contract","href":"/v4/guides/embed-signing"},{"sidebarTitle":"Editor","title":"Embed editor","icon":"browser","href":"/v4/guides/embed-editor"},{"sidebarTitle":"Messaging","title":"Embed messaging","icon":"code","href":"/v4/guides/embed-messaging"}]},{"group":"Templating","icon":"hammer","expanded":false,"pages":[{"sidebarTitle":"Templates","title":"Templates","icon":"file-invoice","href":"/v4/guides/templates"},{"sidebarTitle":"Auto templates","title":"Auto templates","icon":"file-search","href":"/v4/guides/auto-templates"},{"sidebarTitle":"Template data","title":"Template data","icon":"input-text","href":"/v4/guides/template-data"}]},{"group":"Template Tagging","icon":"file-brackets-curly","expanded":false,"pages":[{"sidebarTitle":"Introduction","title":"Introduction","icon":"hand-wave","href":"/v4/guides/template-tagging/introduction"},{"sidebarTitle":"Tags","title":"Tags","icon":"brackets-curly","href":"/v4/guides/template-tagging/tags"},{"sidebarTitle":"Options","title":"Tag options","icon":"list-check","href":"/v4/guides/template-tagging/tag-options"},{"sidebarTitle":"Date formats","title":"Date formats","icon":"calendar","href":"/v4/guides/template-tagging/date-formats"},{"sidebarTitle":"Signer tags","title":"Signer tags","icon":"user-tag","href":"/v4/guides/template-tagging/signer-tags"},{"sidebarTitle":"Custom tags","title":"Custom tags","icon":"input-text","href":"/v4/guides/template-tagging/custom-tags"}]},{"sidebarTitle":"Package options","title":"Package options","icon":"toggle-on","href":"/v4/guides/package-options"},{"title":"Data formats","icon":"binary","href":"/v4/guides/data-formats"},{"sidebarTitle":"External data","title":"External data","icon":"table-cells","href":"/v4/guides/external-data"},{"title":"Errors","icon":"circle-exclamation","href":"/v4/guides/errors"}]},{"group":"API","icon":"file-code","pages":[{"group":"Packages","icon":"file-contract","pages":[{"title":"Add","api":"POST /packages/add","href":"/v4/api/packages/add"},{"title":"Data","api":"GET /packages/{packageId}/data","href":"/v4/api/packages/data"},{"title":"Delete","api":"POST /packages/delete","href":"/v4/api/packages/delete"},{"title":"Download","api":"GET /packages/{packageId}/documents/{documentId}/pdf/{version}/download","href":"/v4/api/packages/download"},{"title":"Get","api":"GET /packages/{packageId}","description":null,"href":"/v4/api/packages/get"},{"title":"List","api":"POST /packages/list","href":"/v4/api/packages/list"},{"title":"Remind signer","api":"POST /packages/signers/remind","description":null,"href":"/v4/api/packages/remind"},{"title":"Rescind","api":"POST /packages/rescind","href":"/v4/api/packages/rescind"},{"title":"Send","api":"POST /packages/send","href":"/v4/api/packages/send"},{"title":"Status","api":"GET /packages/{packageId}/status","href":"/v4/api/packages/status"},{"title":"Update","api":"POST /packages/update","href":"/v4/api/packages/update"}]},{"group":"Files","icon":"files","pages":[{"title":"Upload","api":"POST /files/upload","playground":"simple","href":"/v4/api/files/upload"}]},{"group":"Links","icon":"link","pages":[{"title":"Edit","api":"POST /packages/{packageId}/link/edit","href":"/v4/api/links/edit"},{"title":"Sign","api":"POST /packages/{packageId}/link/sign/{signerId}","href":"/v4/api/links/sign"}]},{"group":"Videos","icon":"video","pages":[{"title":"Delete","api":"POST /packages/{packageId}/videos/delete","href":"/v4/api/videos/delete"},{"title":"List","api":"GET /packages/{packageId}/videos","href":"/v4/api/videos/list"}]},{"group":"Verifications","icon":"id-card","pages":[{"title":"Signer","api":"GET /packages/{packageId}/signers/{signerId}/verification","href":"/v4/api/verifications/signer"},{"title":"View","api":"GET /verifications/{verificationId}/view","href":"/v4/api/verifications/view"}]},{"group":"Templates","icon":"file-invoice","pages":[{"title":"List","api":"POST /templates/list","href":"/v4/api/templates/list"}]},{"group":"MasterFile","icon":"file-certificate","pages":[{"title":"Get","api":"GET /masterfiles/{packageId}","href":"/v4/api/masterfile/get"},{"sidebarTitle":"Download","title":"Download","api":"GET /masterfiles/{packageId}/pdf/download","href":"/v4/api/masterfile/download"},{"title":"Export","api":"POST /masterfiles/export/pdf","href":"/v4/api/masterfile/export"},{"group":"Signer","icon":"user-edit","expanded":true,"pages":[{"title":"Get","api":"GET /masterfiles/{packageId}/signer/{signerId}","href":"/v4/api/masterfile/signer/get"},{"title":"Download","api":"GET /masterfiles/{packageId}/signer/{signerId}/pdf/download","href":"/v4/api/masterfile/signer/download"}]}]}]},{"group":"Webhooks","icon":"rss","pages":[{"sidebarTitle":"Setup","title":"Setup webhooks","icon":"gear","href":"/v4/webhooks/setup"},{"group":"Events","icon":"bolt","pages":[{"title":null,"href":"/v4/webhooks/events/package-add"},{"title":null,"href":"/v4/webhooks/events/package-decline"},{"title":null,"href":"/v4/webhooks/events/package-delete"},{"title":null,"href":"/v4/webhooks/events/package-executed"},{"title":null,"href":"/v4/webhooks/events/package-expired"},{"title":null,"href":"/v4/webhooks/events/package-rescind"},{"title":null,"href":"/v4/webhooks/events/package-send"},{"title":null,"href":"/v4/webhooks/events/package-sent"},{"title":null,"href":"/v4/webhooks/events/package-update"},{"title":null,"href":"/v4/webhooks/events/document-accessed"},{"title":null,"href":"/v4/webhooks/events/document-executed"},{"title":null,"href":"/v4/webhooks/events/document-next"},{"title":null,"href":"/v4/webhooks/events/document-signed"},{"title":null,"href":"/v4/webhooks/events/notification-status"},{"title":null,"href":"/v4/webhooks/events/verification-status"},{"title":null,"href":"/v4/webhooks/events/video-delete"}]}]},{"group":"Reference","icon":"books","expanded":false,"pages":[{"group":"Documents","icon":"files","expanded":false,"pages":[{"sidebarTitle":"Document","title":"Document","icon":"file","tag":"object","href":"/v4/reference/documents/document"},{"sidebarTitle":"Document signer","title":"Document signer","icon":"user-edit","tag":"object","href":"/v4/reference/documents/document-signer"},{"sidebarTitle":"Document status","title":"Document status","icon":"file","tag":"object","href":"/v4/reference/documents/document-status"},{"sidebarTitle":"States","title":"Document states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/documents/document-states"},{"sidebarTitle":"Revision","title":"Document revision","icon":"file","tag":"object","href":"/v4/reference/documents/document-revision"},{"sidebarTitle":"Revision status","title":"Revision status","icon":"check-circle","tag":"object","href":"/v4/reference/documents/revision-status"}]},{"group":"Embed","icon":"code","expanded":false,"pages":[{"sidebarTitle":"Actions","title":"Embed actions","icon":"play-circle","tag":"enum","href":"/v4/reference/embed/embed-actions"},{"sidebarTitle":"Sources","title":"Embed sources","icon":"boxes","tag":"enum","href":"/v4/reference/embed/embed-source"}]},{"group":"Files","icon":"file","expanded":false,"pages":[{"sidebarTitle":"Types","title":"File types","icon":"tags","tag":"enum","href":"/v4/reference/files/file-types"}]},{"sidebarTitle":"Locales","title":"Locales","icon":"globe","tag":"enum","href":"/v4/reference/locales"},{"group":"MasterFiles","icon":"file-certificate","expanded":false,"pages":[{"sidebarTitle":"Access actions","title":"Access history actions","icon":"circle-play","tag":"enum","href":"/v4/reference/masterfiles/masterfile-access-history-actions"},{"sidebarTitle":"Access types","title":"Access history types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-access-history-types"},{"sidebarTitle":"Log types","title":"Log types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-log-types"},{"sidebarTitle":"Notifications","title":"Notification templates","icon":"file-invoice","tag":"enum","href":"/v4/reference/masterfiles/masterfile-notification-templates"},{"sidebarTitle":"Notification types","title":"Notification types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-notification-types"},{"sidebarTitle":"History types","title":"History types","icon":"tags","tag":"enum","href":"/v4/reference/masterfiles/masterfile-package-history-types"}]},{"group":"Meetings","icon":"calendar-days","expanded":false,"pages":[{"sidebarTitle":"Meeting","title":"Meeting","icon":"calendar-day","tag":"object","href":"/v4/reference/packages/meeting"},{"sidebarTitle":"Meeting types","title":"Meeting types","icon":"tags","tag":"enum","href":"/v4/reference/packages/meeting-types"}]},{"group":"Packages","icon":"file-contract","expanded":false,"pages":[{"sidebarTitle":"Package","title":"Package","icon":"file-contract","tag":"object","href":"/v4/reference/packages/package"},{"sidebarTitle":"Consent","title":"Consent","icon":"shield-check","tag":"object","href":"/v4/reference/packages/consent"},{"sidebarTitle":"Package status","title":"Package status","icon":"check-circle","tag":"object","href":"/v4/reference/packages/package-status"},{"sidebarTitle":"Sort by","title":"Sort by","icon":"sort-amount-down","tag":"enum","href":"/v4/reference/packages/package-filter-sort"},{"sidebarTitle":"States","title":"Package states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/packages/package-states"},{"sidebarTitle":"Types","title":"Package types","icon":"tags","tag":"enum","href":"/v4/reference/packages/package-types"}]},{"group":"Package options","icon":"toggle-on","expanded":false,"pages":[{"sidebarTitle":"Options","title":"Package options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/package-options"},{"sidebarTitle":"Consent","title":"Consent options","icon":"shield-check","tag":"object","href":"/v4/reference/package-options/consent-options"},{"sidebarTitle":"Digital signatures","title":"Digital signature options","icon":"file-signature","tag":"object","href":"/v4/reference/package-options/digital-signature-options"},{"sidebarTitle":"Embed","title":"Embed options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/package-embed-options"},{"sidebarTitle":"Geolocation","title":"Geolocation options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/geo-location-options"},{"sidebarTitle":"PDF security","title":"PDF security options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/pdf-security-options"},{"sidebarTitle":"Reminder","title":"Reminder options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/reminder-options"},{"sidebarTitle":"Signer tools","title":"Signer tools","icon":"list-check","tag":"object","href":"/v4/reference/package-options/signer-tools"},{"sidebarTitle":"Verification","title":"Verification options","icon":"list-check","tag":"object","href":"/v4/reference/package-options/verification-options"},{"sidebarTitle":"CAC","title":"CAC values","icon":"file-certificate","tag":"enum","href":"/v4/reference/package-options/package-options-cac"},{"sidebarTitle":"Form flattening","title":"Form flattening","icon":"layer-group","tag":"enum","href":"/v4/reference/package-options/package-options-form-flattening"},{"sidebarTitle":"Mark types","title":"Mark types","icon":"signature","tag":"enum","href":"/v4/reference/package-options/package-options-default-mark"},{"sidebarTitle":"Unused tags","title":"Unused tags","icon":"brackets-curly","tag":"enum","href":"/v4/reference/package-options/package-options-template-unused-signer-tags"}]},{"group":"Recipients","icon":"users","expanded":false,"pages":[{"sidebarTitle":"Recipient","title":"Recipient","icon":"users","tag":"object","href":"/v4/reference/recipients/recipient"},{"sidebarTitle":"Types","title":"Recipient types","icon":"tags","tag":"enum","href":"/v4/reference/recipients/recipient-types"}]},{"group":"Signers","icon":"signature","expanded":false,"pages":[{"sidebarTitle":"Signer","title":"Signer","icon":"user-edit","tag":"object","href":"/v4/reference/signers/signer"},{"sidebarTitle":"Roles","title":"Signer roles","icon":"tags","tag":"enum","href":"/v4/reference/signers/signer-roles"},{"sidebarTitle":"Types","title":"Signer types","icon":"tags","tag":"enum","href":"/v4/reference/signers/signer-types"}]},{"group":"Templates","icon":"file-invoice","expanded":false,"pages":[{"sidebarTitle":"Types","title":"Template types","tag":"enum","href":"/v4/reference/templates/template-types"}]},{"group":"Verifications","icon":"id-card","expanded":false,"pages":[{"sidebarTitle":"Verification","title":"Verification","icon":"id-card","tag":"object","href":"/v4/reference/verifications/verification-view"},{"sidebarTitle":"Result","title":"Verification result","icon":"check-circle","tag":"object","href":"/v4/reference/verifications/verification-view-result"},{"sidebarTitle":"Document","title":"Verification document","icon":"file","tag":"object","href":"/v4/reference/verifications/verification-view-document"},{"sidebarTitle":"Document types","title":"Document types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-document-types"},{"sidebarTitle":"Field types","title":"Field types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-field-types"},{"sidebarTitle":"Image types","title":"Image types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-image-types"},{"sidebarTitle":"Result states","title":"Result states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/verifications/verification-result-states"},{"sidebarTitle":"Result types","title":"Result types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-result-types"},{"sidebarTitle":"Score types","title":"Score types","icon":"tags","tag":"enum","href":"/v4/reference/verifications/verification-score-types"},{"sidebarTitle":"Verification states","title":"Verification states","icon":"arrow-progress","tag":"enum","href":"/v4/reference/verifications/verification-states"}]}]}]},{"tab":"API reference","icon":"code","hidden":true,"pages":[{"title":"API reference","href":"/v4/api-ref/introduction"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/v4/updates"}]}]}]},"basePath":"","title":"List - iinked Sign","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js"]}