Skip to main content

Get User List File Details

Loading...
API endpoint path: /v1/userlists

Retrieves processing details for a user list file identified by userlistFileName. The viewName parameter determines whether the response includes processing status or error report details.

Use this endpoint to:

  • Check processing status, user counts, and processing messages.
  • Determine whether an error report is available.
  • Retrieve error report details when a report has been generated.

Behavior and capabilities:

  • userlistFileName and viewName are required.
  • userlistFileName must match FI<fiId>_<fileLabel>_<yyyyMMddHHmmss>.csv.
  • Supported viewName values:
    • fileStatus: Returns fileMetadata and fileStatus, including job status, user counts, and report availability.
    • fileErrorReport: Returns fileMetadata and, when available, fileErrorReport. fileErrorReport is omitted when no report has been generated and no availability message applies.
  • If processing has not started, fileStatus.jobStatusMessage is Processing Job not yet created.

Request​

Responses​

Success