HomeAPI Reference
API Reference

Retrieves program request summary with advanced filtering options

get
https://api.recvue.com/api/v2.0/programs/summary

Fetches request summary with extensive filter options. Returns all matching results by default. Use 'page' and 'size' parameters for paginated results.

Filter Options:

  • Filter by program ID or import type
  • Search by description keyword
  • Filter by submitting user, request ID, or date range
  • Limit results by maximum request ID
  • Optionally include child requests

Import Type Shortcuts:

  • orders: Automatically resolves to the ORDERHUB program
  • indexImport: Searches by description 'Import Indexes Processor'
  • Any other value: Resolved as a program short name

Sort: Defaults to description:ASC when not specified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64

Filter by program ID

int32
Defaults to 10

Number of records per page. Controls pagination size. Use with 'page' parameter.

int32
Defaults to 1

Page number to retrieve (starts from 1). Use with 'size' parameter for pagination.

sort
array of strings

Field(s) to sort by. Format: fieldName:ASC or fieldName:DESC. Supports multiple fields. Defaults to description:ASC.

sort
fields
array of strings

Specific response fields to include. Reduces response size. Provide comma-separated field names from the response model.

fields
string

Search keyword to filter program requests. Searches across: description.

int64

Filter by specific request ID.

int64

Filter requests submitted within the last N days.

number

Filter by maximum request ID. Returns records with a request ID less than or equal to this value.

string
enum

Include child requests in the response. Accepted values: Y or N.

Allowed:
string

Filter by import type. Use 'orders' for ORDERHUB program, 'indexImport' for Import Indexes Processor, or provide any other program short name.

int64

Filter by user ID who created the request.

Responses

400

Invalid request parameters (e.g., incorrect sort parameter format — expected fieldName:ASC or fieldName:DESC)

401

Unauthorized - Invalid or missing authentication

500

Internal server error or invalid importType value provided

Updated 3 months ago

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

Updated 3 months ago