> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://partner.ninjatrader.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server.
# Agreement Document Items
GET https://live.tradovateapi.com/v1/agreementDocument/items
### Return multiple agreement document records by their entity IDs.
**Available to:** All authenticated users
**Environments:** Demo, Live
**[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit
Returns several `AgreementDocument` entities in one call. Identify them with the `ids` query parameter — a comma-separated list of integer entity IDs. Each record ties a customer application to one agreement required for it: `customerApplicationId` identifies the application, `agreementDocumentTemplateId` identifies the template the document was generated from, and `locale` records the document's language. The `timestamp` field marks when the record was created, and `signedTimestamp` appears once the document has been signed — an unsigned document has no `signedTimestamp`.
The platform creates these records when you call [`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents) for a customer application; you can't create or modify them directly through the API. Pass their IDs to [`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents) as `agreementIds` when the applicant signs, and download the generated PDF with [`getAgreementDocument`](/api/rest-api-endpoints/users/get-agreement-document).
The endpoints that create and populate agreement documents — [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application) and [`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents) — are available on Live only, so you'll typically query these records on the Live environment.
To fetch a single record by ID, use [`agreementDocumentItem`](/api/rest-api-endpoints/users/agreement-document-item). To list every agreement document for a customer application, use [`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents).
**Common Failure Scenarios**
- An ID in the list doesn't exist or isn't accessible to the calling user (returns `HTTP 404`).
- The access token is missing or invalid (returns `HTTP 401`).
Reference: https://partner.ninjatrader.com/connect/api/rest-api-endpoints/users/agreement-document-items
## OpenAPI Specification
```yaml
openapi: 3.1.0
info:
title: connect
version: 1.0.0
paths:
/agreementDocument/items:
get:
operationId: agreement-document-items
summary: Agreement Document Items
description: >-
### Return multiple agreement document records by their entity IDs.
**Available to:** All authenticated users
**Environments:** Demo, Live
**[Rate Limit](/overview/core-concepts/rate-limits):** No
endpoint-specific limit
Returns several `AgreementDocument` entities in one call. Identify them
with the `ids` query parameter — a comma-separated list of integer
entity IDs. Each record ties a customer application to one agreement
required for it: `customerApplicationId` identifies the application,
`agreementDocumentTemplateId` identifies the template the document was
generated from, and `locale` records the document's language. The
`timestamp` field marks when the record was created, and
`signedTimestamp` appears once the document has been signed — an
unsigned document has no `signedTimestamp`.
The platform creates these records when you call
[`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents)
for a customer application; you can't create or modify them directly
through the API. Pass their IDs to
[`signAgreementDocuments`](/api/rest-api-endpoints/users/sign-agreement-documents)
as `agreementIds` when the applicant signs, and download the generated
PDF with
[`getAgreementDocument`](/api/rest-api-endpoints/users/get-agreement-document).
The endpoints that create and populate agreement documents —
[`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application)
and
[`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents)
— are available on Live only, so you'll typically query these records on
the Live environment.
To fetch a single record by ID, use
[`agreementDocumentItem`](/api/rest-api-endpoints/users/agreement-document-item).
To list every agreement document for a customer application, use
[`agreementDocumentDependents`](/api/rest-api-endpoints/users/agreement-document-dependents).
**Common Failure Scenarios**
- An ID in the list doesn't exist or isn't accessible to the calling
user (returns `HTTP 404`).
- The access token is missing or invalid (returns `HTTP 401`).
tags:
- Users
parameters:
- name: ids
in: query
required: true
schema:
type: array
items:
type: integer
format: int64
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: AgreementDocument
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AgreementDocument'
servers:
- url: https://live.tradovateapi.com/v1
description: https://live.tradovateapi.com/v1
components:
schemas:
AgreementDocument:
type: object
properties:
id:
type: integer
format: int64
customerApplicationId:
type: integer
format: int64
timestamp:
type: string
format: date-time
agreementDocumentTemplateId:
type: integer
format: int64
signedTimestamp:
type: string
format: date-time
locale:
type: string
required:
- customerApplicationId
- timestamp
- agreementDocumentTemplateId
title: AgreementDocument
securitySchemes:
bearer_access_token:
type: http
scheme: bearer
```
## Examples
**Request**
```json
{}
```
**Response**
```json
[
{
"customerApplicationId": 56789,
"timestamp": "2024-04-10T14:22:00Z",
"agreementDocumentTemplateId": 301,
"id": 1024,
"signedTimestamp": "2024-04-11T09:15:00Z",
"locale": "en-US"
},
{
"customerApplicationId": 56789,
"timestamp": "2024-04-10T14:25:00Z",
"agreementDocumentTemplateId": 302,
"id": 2048,
"signedTimestamp": null,
"locale": "en-US"
},
{
"customerApplicationId": 67890,
"timestamp": "2024-04-12T08:00:00Z",
"agreementDocumentTemplateId": 303,
"id": 4096,
"signedTimestamp": "2024-04-12T10:30:00Z",
"locale": "fr-FR"
}
]
```
**SDK Code**
```python
import requests
url = "https://live.tradovateapi.com/v1/agreementDocument/items"
querystring = {"ids":"1024,2048,4096"}
payload = {}
headers = {
"Authorization": "Bearer ",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers, params=querystring)
print(response.json())
```
```javascript
const url = 'https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096';
const options = {
method: 'GET',
headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'},
body: '{}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Bearer ")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
```
```ruby
require 'uri'
require 'net/http'
url = URI("https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer '
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body
```
```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;
HttpResponse response = Unirest.get("https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096")
.header("Authorization", "Bearer ")
.header("Content-Type", "application/json")
.body("{}")
.asString();
```
```php
request('GET', 'https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096', [
'body' => '{}',
'headers' => [
'Authorization' => 'Bearer ',
'Content-Type' => 'application/json',
],
]);
echo $response->getBody();
```
```csharp
using RestSharp;
var client = new RestClient("https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer ");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```
```swift
import Foundation
let headers = [
"Authorization": "Bearer ",
"Content-Type": "application/json"
]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/agreementDocument/items?ids=1024%2C2048%2C4096")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
```