Agreement Document Template Find

GET

https://live.tradovateapi.com/v1/agreementDocumentTemplate/find

GET

/v1/agreementDocumentTemplate/find

$ curl -G https://live.tradovateapi.com/v1/agreementDocumentTemplate/find \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      --data-urlencode "name=Standard Futures Agreement"

200Retrieved

1 {
2   "name": "Standard Futures Agreement",
3   "timestamp": "2024-01-15T09:30:00Z",
4   "adminUseOnly": false,
5   "individual": true,
6   "joint": true,
7   "IRA": false,
8   "trust": true,
9   "LLC": true,
10   "ACH": true,
11   "externalRef": "AGT-2024-STD-FUT-001",
12   "highRisk": false,
13   "hedging": true,
14   "personalGuarantor": false,
15   "corporation": true,
16   "partnership": false,
17   "id": 1024,
18   "professional": false,
19   "usaCustomer": true,
20   "usaJointCustomer": false,
21   "optionalSignature": true,
22   "otherEntityControl": false,
23   "genericSignWhitelist": false,
24   "priority": 5,
25   "clearingHouseId": 12,
26   "countryId": 840,
27   "organizationId": 305,
28   "templatePreviewWhitelist": true
29 }

Retrieve an agreement document template by name.

Available to: All authenticated users. Templates marked adminUseOnly are visible only to internal NinjaTrader administrators.

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Fetch a single agreement document template using its name field (up to 64 characters). Agreement document templates define the customer agreement documents that are generated during application onboarding.

Template names are unique per clearing house, so a name lookup can help you locate a known template without knowing its entity ID.

Related Endpoints

Use agreementDocumentTemplateFinds to fetch several templates by name in one call.
Use agreementDocumentTemplateSuggest when you only know part of the name.
Use agreementDocumentTemplateItem to fetch a template by ID instead.

### Retrieve an agreement document template by name. **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 Fetch a single agreement document template using its `name` field (up to 64 characters). Agreement document templates define the customer agreement documents that are generated during application onboarding. Template names are unique per clearing house, so a name lookup can help you locate a known template without knowing its entity ID. **Related Endpoints** - Use [`agreementDocumentTemplateFinds`](/api/rest-api-endpoints/users/agreement-document-template-finds) to fetch several templates by name in one call. - Use [`agreementDocumentTemplateSuggest`](/api/rest-api-endpoints/users/agreement-document-template-suggest) when you only know part of the name. - Use [`agreementDocumentTemplateItem`](/api/rest-api-endpoints/users/agreement-document-template-item) to fetch a template by ID instead.

Authentication

AuthorizationBearer

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

Query parameters

namestringRequired

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