Retrieves a paginated list of QuickLinks for a specific site with optional filtering, search, and sorting.
The search parameter performs a case-insensitive partial match on Name and Slug fields. If the search value is parseable as a long integer, it will also search by exact ID match. Example: search="pause" will match QuickLinks with "pause" in their name or slug. Example: search="5" will match QuickLink with ID=5 OR name/slug containing "5".
Multiple statuses/actionTypes can be specified to filter by any of the values: Example: ?statuses=0&statuses=1 returns QuickLinks with status Disabled OR Enabled. Example: ?actionTypes=0&actionTypes=2 returns QuickLinks with action type Resume OR Cancel.
Request
- Base URLhttps://api.qpilot.cloud
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The unique identifier of the site
Query parameters
Optional array of QuickLink statuses to filter by (0=Disabled, 1=Enabled, 2=Deleted). Returns QuickLinks matching any of the specified statuses.
Optional array of action types to filter by (0=Resume, 1=Pause, 2=Cancel, etc.). Returns QuickLinks matching any of the specified action types.
Optional search term to filter by ID (if parseable as long), Name, or Slug (case-insensitive partial match)
The one-based page number (default: 1)
Number of items per page (default: 25)
Field to order by (default: CreatedUtc)
Sort order: 'asc' or 'desc' (default: desc)
Response
Returns the paginated list of QuickLinks
Changes
No recorded changes to this operation across all 2 revisions of this API.