Skip to main content
GET
Get an export

Authorizations

Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Path Parameters

id
string
required
read-only

The ID of the export 24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

Response

OK

An export job that produces a CSV of lead events for a given time range and field selection.

id
string
required
read-only

ID of this export

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

created_at
string<date-time>
required

When the export was requested.

status
enum<string>
required

Current state of the export job.

Available options:
created,
processing,
complete,
error,
truncated
start
string<date-time>

Start of the time range covered by this export (inclusive).

end
string<date-time>

End of the time range covered by this export (exclusive).

filter_rules
object[]

Rules used to filter the events included in the export.

email_to
string[]

Email addresses notified when the export completes.

fields
string[]

Lead/event fields included in the resulting CSV.

date_format
enum<string>

Date format used in the resulting CSV.

Available options:
standard,
legacy
user
object

User who requested the export.

expires_at
string<date-time>

When the export becomes unavailable for download.

reason
object

Optional explanation when the status is truncated or error.

error
string

Error message when the status is error.

exported_docs
integer

Number of lead/event records included in the resulting CSV.

file_name
string

Name of the resulting CSV file.

downloads
object[]

Audit log of users who have downloaded this export.