Agreement Document Template List

View as Markdown
### List all agreement document templates. **Available to:** All authenticated users. Templates marked `adminUseOnly` are visible only to internal NinjaTrader administrators. **Environments:** Demo, Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Retrieve every agreement document template visible to your user. Agreement document templates define the customer agreement documents that are generated when a customer application is prepared for signing — during onboarding, agreement documents are created from the templates that match the application. A template's boolean flags control which applications it applies to: - **Account type flags** (`individual`, `joint`, `IRA`, `trust`, `corporation`, `partnership`, `LLC`): the template applies to applications with a matching legal status. - **Condition flags** (`highRisk`, `hedging`, `personalGuarantor`, `professional`, `usaCustomer`, `usaJointCustomer`, `otherEntityControl`): the template applies only when the application matches these conditions. - **Scope references** (`clearingHouseId`, `organizationId`, `countryId`): when set, the template applies only to that clearing house, organization, or country. When empty, the template isn't restricted by that scope. Template names are unique per clearing house. **Related Endpoints** - Use [`agreementDocumentTemplateItem`](/api/rest-api-endpoints/users/agreement-document-template-item) to fetch a single template by ID. - Use [`agreementDocumentTemplateSuggest`](/api/rest-api-endpoints/users/agreement-document-template-suggest) to search templates by text. - Each generated agreement document references its template — see [`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents). - Documents are generated from templates when you call [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application) or [`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

AgreementDocumentTemplate
namestring<=64 characters
timestampdatetime
adminUseOnlyboolean
individualboolean
jointboolean
IRAboolean
IRA
trustboolean
LLCboolean
LLC
ACHboolean
ACH
externalRefstring<=8192 characters
highRiskboolean
hedgingboolean
personalGuarantorboolean
corporationboolean
partnershipboolean
idlong
professionalboolean
usaCustomerboolean
usaJointCustomerboolean
optionalSignatureboolean
otherEntityControlboolean
genericSignWhitelistboolean
priorityinteger
clearingHouseIdlong
countryIdlong
organizationIdlong
templatePreviewWhitelistboolean