Both the GET /products and GET /transactions REST API endpoints adhere to a standard result set pagination scheme, which can be controlled and introspected via a couple query parameters and a response header.
Request Query Parameters:
start
A non-negative integer valued property indicating the index of the query result set from which to start returning results. The default value is 0 and can not exceed the size of the result set as represented by the X-Total-Count response header.
limit
A non-negative integer valued property indicating the number of query results to return. The default value is 25, and the max value is 50.
Response Header:
X-Total-Count
A non-negative integer value representing the total size of the result set that matched the API request.
Example:
In the sample query below, the result set has 10 items, as represented by the X-Total-Count response header, but the caller has asked only for the first 5 items (start=0 and limit=5), which are returned in the response body.
The caller can subsequently ask for the next and final 5 items by setting start=5 (the 5th index representing the 6th element in the result set, 0 indexing) and limit=5.
Request:
GET /partner/v2/products?start=0&limit=5 HTTP/1.1
Host: https://api.elliemae.com
Authorization: Bearer <access_token>
Response:
Headers:
...
X-Total-Count: 10
...
Body:
[
{
"id": "d3c15239-1c7d-4cac-8703-3601c0a4c14c",
"partnerId": "99999999",
"name": "product-1",
"listingName": "Product 1",
"requestTypes": [
"NEW_REQUEST"
],
"environment": "sandbox",
"status": "development",
"interfaceUrl": "https://app.integration.com/order",
"adminInterfaceUrl": "https://app.integration.com/admin",
"integrationType": "ASYNC",
"credentials": [
{
"id": "username",
"type": "string",
"title": "Username",
"minimum": 4,
"maximum": 30,
"secret": false,
"scope": "user",
"required": true
},
{
"id": "password",
"type": "string",
"title": "Password",
"pattern": "^.*(?=.",
"minimum": 8,
"maximum": 30,
"secret": true,
"scope": "company",
"required": true
}
],
"tags": {
"workflows": [
"automated",
"interactive"
],
"categories": [
"APPRAISAL"
],
"applications": [
"LO Connect",
"Encompass Smart Client"
]
},
"extensionLimit": 0
},
{
"id": "6eaac299-15ae-4ef3-bba2-57b8f88a1185",
"partnerId": "99999999",
"name": "product-2",
"listingName": "Product 2",
"requestTypes": [
"NEW_REQUEST"
],
"environment": "sandbox",
"status": "development",
"interfaceUrl": "https://app.integration.com/order",
"adminInterfaceUrl": "https://app.integration.com/admin",
"integrationType": "ASYNC",
"credentials": [
{
"id": "username",
"type": "string",
"title": "Username",
"minimum": 4,
"maximum": 30,
"secret": false,
"scope": "user",
"required": true
},
{
"id": "password",
"type": "string",
"title": "Password",
"pattern": "^.*(?=.",
"minimum": 8,
"maximum": 30,
"secret": true,
"scope": "company",
"required": true
}
],
"tags": {
"workflows": [
"automated",
"interactive"
],
"categories": [
"APPRAISAL"
],
"applications": [
"LO Connect",
"Encompass Smart Client"
]
},
"extensionLimit": 0
},
{
"id": "cb583d3f-1267-4357-913e-c038d7d58314",
"partnerId": "99999999",
"name": "product-3",
"listingName": "Product 3",
"requestTypes": [
"NEW_REQUEST"
],
"environment": "sandbox",
"status": "development",
"interfaceUrl": "https://app.integration.com/order",
"adminInterfaceUrl": "https://app.integration.com/admin",
"integrationType": "ASYNC",
"credentials": [
{
"id": "username",
"type": "string",
"title": "Username",
"minimum": 4,
"maximum": 30,
"secret": false,
"scope": "user",
"required": true
},
{
"id": "password",
"type": "string",
"title": "Password",
"pattern": "^.*(?=.",
"minimum": 8,
"maximum": 30,
"secret": true,
"scope": "company",
"required": true
}
],
"tags": {
"workflows": [
"automated",
"interactive"
],
"categories": [
"APPRAISAL"
],
"applications": [
"LO Connect",
"Encompass Smart Client"
]
},
"extensionLimit": 0
},
{
"id": "3b039fb1-06d4-447e-b7f0-c4729b1266a9",
"partnerId": "99999999",
"name": "product-4",
"listingName": "Product 4",
"requestTypes": [
"NEW_REQUEST"
],
"environment": "sandbox",
"status": "development",
"interfaceUrl": "https://app.integration.com/order",
"adminInterfaceUrl": "https://app.integration.com/admin",
"integrationType": "ASYNC",
"credentials": [
{
"id": "username",
"type": "string",
"title": "Username",
"minimum": 4,
"maximum": 30,
"secret": false,
"scope": "user",
"required": true
},
{
"id": "password",
"type": "string",
"title": "Password",
"pattern": "^.*(?=.",
"minimum": 8,
"maximum": 30,
"secret": true,
"scope": "company",
"required": true
}
],
"tags": {
"workflows": [
"automated",
"interactive"
],
"categories": [
"APPRAISAL"
],
"applications": [
"LO Connect",
"Encompass Smart Client"
]
},
"extensionLimit": 0
},
{
"id": "0a8895de-beee-40e6-9ad7-89b06ca5e745",
"partnerId": "99999999",
"name": "product-5",
"listingName": "Product 5",
"requestTypes": [
"NEW_REQUEST"
],
"environment": "sandbox",
"status": "development",
"interfaceUrl": "https://app.integration.com/order",
"adminInterfaceUrl": "https://app.integration.com/admin",
"integrationType": "ASYNC",
"credentials": [
{
"id": "username",
"type": "string",
"title": "Username",
"minimum": 4,
"maximum": 30,
"secret": false,
"scope": "user",
"required": true
},
{
"id": "password",
"type": "string",
"title": "Password",
"pattern": "^.*(?=.",
"minimum": 8,
"maximum": 30,
"secret": true,
"scope": "company",
"required": true
}
],
"tags": {
"workflows": [
"automated",
"interactive"
],
"categories": [
"APPRAISAL"
],
"applications": [
"LO Connect",
"Encompass Smart Client"
]
},
"extensionLimit": 0
}
]