(NEW!) List Requests

COMING SOON

Use this endpoint to return a listing of all Requests. The request body is entirely optional, and by default, the API will return all types of Requests sorted by created_date from the most recent to the oldest in batches of 100.

No metadata on the requests is returned from this endpoint.

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

Request Body schema: application/json
optional

The Request Body must be a JSON object.

from
integer

Starting index for each request, used in conjunction with the limit property to paginate results.

limit
integer [ 1 .. 100 ]

Number of results to return per request/page.

type
string

Optional property to filter the response to only specific Request Types.

status
string

Optional property to filter the response to only Requests with a specific status.

includes
Array of arrays

Optional array to provide searchField values for the metadata attributes on the Requests that you'd like returned in addition to the standard Request data.

Responses
200

Changes applied successfully.

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

post/request/list
Request samples
application/json
{
  • "from": 0,
  • "limit": 100,
  • "type": "Upload",
  • "status": "In Progress",
  • "includes": [
    ]
}
Response samples
application/json
{
  • "total": 54,
  • "results": [
    ]
}