v4

latestSwagger 2.02026-08-0343714211.7 MB

requests

Requests

List Requests

get/requests

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are .

mineboolean

Only show requests of the current user? (Defaults to true if current user is not a site admin.)

pathstring

Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Response

A list of Requests objects.

idinteger

Request ID

pathstring

Folder path

sourcestring

Source filename, if applicable

destinationstring

Destination filename

automation_idinteger

ID of automation that created request

user_display_namestring

User making the request (if applicable)

Example response

[
  {
    "id": 1,
    "path": "example",
    "source": "example",
    "destination": "example",
    "automation_id": 1,
    "user_display_name": "example"
  }
]