Get all jobs

Get all the jobs associated with a catalog.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 64

Your unique account name.

string
required
length between 1 and 64

"Catalog name" is also called domain key. Use the same value as your domain key in your search API requests.

string
enum
required
length between 1 and 64

The type of environment you want to use for the request (Production/Staging).

Allowed:
Query Params
integer
≥ 1
Defaults to 1

To navigate through paginated results, use the page number to switch between pages.

integer
1 to 200
Defaults to 20

Specify the maximum number of pages to return in the response.

class
array of strings
length ≥ 1

Filter the jobs based on comma-separated class values:

  • feed_records_full — Include full feed jobs in response, that is, if type=feed and feed_mode=full
  • feed_records_delta - Include delta feed jobs in response, that is, if type=feed and feed_mode=delta
  • index_update - Include update index jobs from search quality in response, that is, if type=index, index_mode=update
  • index_refresh - Include refresh index jobs in response, that is, if type=index, index_mode=refresh
  • suggest_refresh - Include suggestions for refresh jobs in response

If no filter value is provided, all jobs are returned by default, regardless of job class. This is equivalent to passing all job class values in the parameter.

class
Allowed:
Responses

401

Unauthorized

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.