Get All Queued Jobs - Sellercloud API Docs

Get All Queued Jobs

Overview

You can use this endpoint to retrieve paged results of existing Queued Jobs with the option to specify different filtering values. For a complete set of results, multiple requests should be made by specifying a page number in the request.

To consume this endpoint, you must be an Authenticated User. As soon as you receive a valid token, you need to pass it to the call for getting queued jobs.

Endpoint

An example of this endpoint for server XX is:

https:// xx.api.sellercloud.com/rest/api/QueuedJobs?pageNumber=1&pageSize=1

For your server, the endpoint will be:

https:// {your_server_id}.api.sellercloud.com/rest/api/QueuedJobs?pageNumber=1&pageSize=1

Request

Method Type: HttpGet
Authorization: Use Bearer Token + token received from token authentication
Header info: Content-Type: application/json
Query Parameters:


Parameters	Data Type	Description	Is Required
pageNumber	integer	Page number that will be retrieved. If the page number is not set in the request, then only 1st page will be pulled.	No
pageSize	integer	Number of results per page. If not set in the request, then the top 10 picklists will be pulled. The maximum number of results per page is 50.	No
jobID	integer	Retrieve a single Job by its ID.	No
companyIDList	List	List of IDs of companies.	No
submittedFrom	DateTime	Earliest date of submitting the job.	No
submittedTo	DateTime	Latest date of submitting the job.	No
jobType	List(enum)	You can see the available values here.	No
jobStatuses	List	You can see the available values here.	No
submittedBy	integer	ID of the employee who has submitted the job.	No
queuedJobPriorities	List (enum)	BelowNormal=0, Normal=1, High=2, Critical=3.	No

Response

If the user is authenticated and provides a valid page number and page size, then the response will be Status Code 200 => OK and queued jobs metadata in JSON format.
If the user is not authenticated, then the response will be Status Code 401 => Not Valid Token.
In case of an error, the response will be Status Code 500 => Internal Server Error.

Response Body

{
  "Items": [
    {
      "SubmittedOn": "2026-03-04T13:07:38.043Z",
      "QueuedJobPriority": 0,
      "CompanyName": "string",
      "QueuedJobType": 0,
      "QueuedJobStatus": 0,
      "StartedOn": "2026-03-04T13:07:38.043Z",
      "CompletedOn": "2026-03-04T13:07:38.043Z",
      "TimeElapsed": 0,
      "ErrorMessage": "string",
      "UserID": 0,
      "SubmittedBy": "string",
      "InputFile": "string",
      "OutputFile": "string",
      "CompanyID": "string",
      "RelatedTaskID": 0,
      "ScheduleTime": "2026-03-04T13:07:38.043Z",
      "ID": 0
    }
  ],
  "TotalResults": 0
}