LOlocalfalcon
Scans & Reports

List all Scheduled Scans

Allows you to retrieve a list of all Auto Scans associated with your Local Falcon account.

If more records exist than is allowed within the set limit, a value will be returned under next_token that can be used as a parameter to request the next page of results.

post/v1/autoscans/

Request

  • Base URL
    https://api.localfalcon.com
  • Auth
    none declared

Request body application/x-www-form-urlencoded

api_keystring required

Your Local Falcon API key.

limitinteger

The number of results you wish to retrieve.

start_datestring

A lower limit (oldest) next run date you wish to retrieve. Expects date formatted as MM/DD/YYYY.

end_datestring

Upper limit (newest) next run date you wish to retrieve. Expects date formatted as MM/DD/YYYY.

place_idstring

Filter only results for specific platform place ID.

keywordstring

Filter only results similar to specified keyword (loose match).

grid_size'3' | '5' | '7' | '9' | '11' | '13' | '15' | '17' | '19' | '21'

Filter only for specific grid sizes.

frequency'one-time' | 'daily' | 'weekly' | 'biweekly' | 'monthly'

Filter only records with a specific run frequency.

status'scheduled' | 'paused'

Filter only records with a specific status.

platformstring

Filter only records for specified Platforms. Expects either one or multiple values of aimode, apple, chatgpt, gaio, gemini, google, grok; separated by commas.

next_tokenstring

This parameter is used to get the next 'page' of results. The value used with the parameter is provided from a previous response by this endpoint if more 'pages' of results exist.

Response

Successful response

codeinteger
code_descboolean
successboolean
messageboolean
parametersobject

Changes

No recorded changes to this operation across all 5 revisions of this API.