Export Login Records

Available Since Version 1.7.0

This API is used to export Login Records, the response will be a compressed zip archive of CSV files.

Request#

Using GET parameters#

Export the Login Records matching the criteria

When calling the API using a GET request you will send the export criteria on the URL using request parameters. In order to simplify the example URL above, not every possible parameter is shown, however using the provided pattern you may add any of the documented request parameters to the URL.

Request Parameters#

applicationIdUUIDoptional

The unique Id of the Application used to reduce the export result to logins for a particular application.

dateTimeSecondsFormatStringoptional

The format string used to format the date and time columns in the export result.

When this parameter is omitted a default format of M/d/yyyy hh:mm:ss a z will be used. See the DateTimeFormatter patterns for additional examples.

endLongoptional

The end instant of the date/time range to search within.

startLongoptional

The start instant of the date/time range to search within.

userIdUUIDoptional

The unique Id of the User used to reduce the export result to logins for a particular user.

zoneIdStringoptional

The time zone used to adjust the stored UTC time in the export result.

For example:

America/Denver or US/Mountain

When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.

Using a request body#

Export the Login Records matching the criteria

When calling the API using a POST request you will send the export criteria in a JSON request body.

Request Body#

criteria.applicationIdUUIDoptional

The unique Id of the Application used to reduce the export result to logins for a particular application.

criteria.endLongoptional

The end instant of the date/time range to include in the export.

criteria.startLongoptional

The start instant of the date/time range to include in the export.

criteria.userIdUUIDoptional

The unique Id of the User used to reduce the export result to logins for a particular user.

dateTimeSecondsFormatStringoptional

The format string used to format the date and time columns in the export result.

When this parameter is omitted a default format of M/d/yyyy hh:mm:ss a z will be used. See the DateTimeFormatter patterns for additional examples.

zoneIdStringoptional

The time zone used to adjust the stored UTC time in the export result.

For example:

America/Denver or US/Mountain

When this parameter is omitted the configured default report time zone will be used. See reportTimezone in the System Configuration API.

Response#

The response for this API will contain a compressed zip of the login records.

In version 1.59.0 and later, the export file contains Identity value and Identity type columns. If a login record is associated with a particular identity, those values will be reflected in the export. Older login records and new login records not associated with a particular identity will omit values for these columns in the export.

Response Codes

Code	Description
200	The request was successful. The response will be a compressed archive byte stream with a `Content-Type` of `application/zip`.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Sample file export

"User Id ","Identity value ","Identity type ","Time ","Application Id ","IP Address ","City ","Country ","Zipcode ","Region ","Latitude ","Longitude "
00000000-0000-0000-0000-000000000001,,,5/12/2025 02:46:44 PM MDT,,107.170.227.24,San Francisco,US,,CA,37.7309,-122.3886
00000000-0000-0000-0000-000000000001,richard@piedpiper.com,email,5/12/2025 12:25:12 AM MDT,3c219e58-ed0e-4b18-ad48-f4f92793ae32,127.0.0.1,,,,,,

The location information is only included in exports when Advanced Threat Detection is enabled.