Filter parameters that allow greater customisation of the list response
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
account_ids |
T.nilable(::String) | ➖ | A comma-separated list of account IDs to filter the results by. | 45355976281015164504,45355976281015164505 |
actions |
T.nilable(::String) | ➖ | A comma-separated list of actions to filter the results by. | download,upload |
child_resources |
T.nilable(::String) | ➖ | A comma-separated list of child resources to filter the results by. | documents,time-off |
end_date |
Date | ➖ | A ISO8601 date string to filter the results by end_date. | 2020-01-01T00:00:00.000Z |
http_methods |
T.nilable(::String) | ➖ | A comma-separated list of HTTP methods to filter the results by. | GET,POST |
order_by |
T.nilable(Models::Operations::QueryParamOrderBy) | ➖ | The field to order the results by. | created_at |
order_direction |
T.nilable(Models::Operations::QueryParamOrderDirection) | ➖ | The direction to order the results by. | asc |
providers |
T.nilable(::String) | ➖ | A comma-separated list of provider keys to filter the results by. | ashby,greenhouse |
request_ids |
T.nilable(::String) | ➖ | A comma-separated list of request IDs to filter the results by. | adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c |
resources |
T.nilable(::String) | ➖ | A comma-separated list of resources to filter the results by. | employees,users |
services |
T.nilable(::String) | ➖ | A comma-separated list of services to filter the results by. | hris,ats |
source_ids |
T.nilable(::String) | ➖ | A comma-separated list of source IDs to filter the results by. | |
source_types |
T.nilable(::String) | ➖ | A comma-separated list of source types to filter the results by. | DASHBOARD,SYNTHETIC_WEBHOOK |
source_values |
T.nilable(::String) | ➖ | A comma-separated list of source values to filter the results by. | |
start_date |
Date | ➖ | A ISO8601 date string to filter the results by start_date. | 2020-01-01T00:00:00.000Z |
status_codes |
T.nilable(::String) | ➖ | A comma-separated list of status codes to filter the results by. | 200,400 |
sub_resources |
T.nilable(::String) | ➖ | A comma-separated list of sub resources to filter the results by. | documents,employees |
success |
T.nilable(T::Boolean) | ➖ | A boolean value to filter the results by success or failure. | true |