Skip to content

List file match jobs

GET
/v1/match/file
curl --request GET \
--url 'https://api.infiniteaudience.ai/v1/match/file?limit=30&status=pending' \
--header 'Authorization: Bearer <token>'

List file match jobs for the org, newest first. Cursor-paginated. Optional status filter. Job history persists even after the underlying segment or its linked audience is deleted from Library — deleted jobs are not excluded from this list. Requires ‘discovery’ scope.

limit
integer
default: 30 <= 100
cursor
string

Opaque next_cursor from the previous response. Keep filters unchanged. Mutually exclusive with legacy before.

before
string format: date-time

Exclusive upper bound cursor on created_at (ISO 8601)

status
string
Allowed values: pending active failed archived expired

Filter by segment status

Paginated list of file match jobs

Media typeapplication/json
object
jobs
required
Array<object>

A file-based match job (matched-subtype segment)

object
data_release
required
One of:

Delivered IAG refresh version. Independent of license status. Null provenance means unknown; a newer refresh-major can prompt a refresh through existing workflows. Active licenses and existing identity IDs support free refresh; normal charges may apply otherwise.

object
major
required
integer
>= 1
minor
required
integer
match_id
required
string
name
required
string
status
required
string
Allowed values: pending active failed archived expired
matching_status
required
string | null
Allowed values: pending processing completed failed
input_record_count
required
integer | null
match_count
required
integer | null
match_rate
required
number | null format: float
amount_charged
required

One-time file-match USD estimate accepted when this run first participates in a successful delivery. Null before first delivery; excludes the delivery’s separate audience/destination/field usage and is not a finalized invoice amount.

number | null
file_format
required
string | null
Allowed values: csv avro json jsonl
compression
required

Input artifact compression, normalized to none for legacy jobs.

string
Allowed values: none gzip
column_mappings
object | null
mapping_warnings

Warnings about how the uploaded file’s columns are used. analysis entries are the automatic column analysis’s warnings on low-confidence mappings (below 0.6) that feed matching, and appear only when that analysis produced column_mappings. A nested_addresses entry is recomputed on every matching run, whoever supplied the mappings, when the addresses column has unrecognized keys or is not an array of address objects (it is then ignored). null before the first run’s analysis step. Returned by the single-job lookup only.

Array<object> | null
object
source_column
required

The uploaded file’s column the warning is about.

string
code
required

analysis is the automatic column analysis’s warning on a low-confidence mapping; nested_addresses is the platform’s check of the addresses column.

string
Allowed values: analysis nested_addresses
warning
required
string
error_message
string | null
segment_id
required
string
audience_id
required
string | null
audience_status
required

Whether the linked audience (if any) is still active in Library. archived covers both an explicitly archived audience and a deleted one. null when there’s no audience_id, or its audience document no longer exists. This job’s own history is unaffected either way — it persists even after the underlying segment or audience is deleted from Library.

string | null
Allowed values: active archived
source_job_id
required
string | null
integration_run_id

Present only for an authorized private partnership workflow.

string
/^ir_[A-Za-z0-9_-]{40}$/
created_at
required
string | null format: date-time
expires_at
required
string | null
has_more
required
boolean
next_cursor
required

Pass as cursor for the next page; null at the end.

string | null
Example
{
"jobs": [
{
"status": "pending",
"matching_status": "pending",
"file_format": "csv",
"compression": "none",
"mapping_warnings": [
{
"code": "analysis"
}
],
"audience_status": "active"
}
]
}

Invalid request — malformed body, missing required attribute, or failed validation. See error and message for details.

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
next_step

Public action for correcting the request or retrying later.

string
issues
Array<object>
object
path
required

JSON path to the invalid filter field or value.

string
code
required
string
Allowed values: INVALID_FILTER_SHAPE UNKNOWN_FILTER_FIELD FIELD_NOT_FILTERABLE UNSUPPORTED_FILTER_OPERATOR UNSUPPORTED_TEXT_COMPARISON INVALID_FILTER_VALUE INVALID_ENUM_VALUE AMBIGUOUS_ENUM_VALUE
message
required
string
suggestions
Array<string>
key
additional properties
any
Examples
Examplevalidation_error
{
"error": "Bad Request",
"code": "MISSING_SEGMENTS",
"message": "segment_ids is required for filter audiences."
}

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
next_step

Public action for correcting the request or retrying later.

string
issues
Array<object>
object
path
required

JSON path to the invalid filter field or value.

string
code
required
string
Allowed values: INVALID_FILTER_SHAPE UNKNOWN_FILTER_FIELD FIELD_NOT_FILTERABLE UNSUPPORTED_FILTER_OPERATOR UNSUPPORTED_TEXT_COMPARISON INVALID_FILTER_VALUE INVALID_ENUM_VALUE AMBIGUOUS_ENUM_VALUE
message
required
string
suggestions
Array<string>
key
additional properties
any
Examples
{
"error": "Unauthorized: Missing or invalid Authorization header"
}

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

Media typeapplication/json
object
error
required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string
message

Human-readable explanation of the error.

string
code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string
request_id

Opaque support/debug identifier when available.

string
next_step

Public action for correcting the request or retrying later.

string
issues
Array<object>
object
path
required

JSON path to the invalid filter field or value.

string
code
required
string
Allowed values: INVALID_FILTER_SHAPE UNKNOWN_FILTER_FIELD FIELD_NOT_FILTERABLE UNSUPPORTED_FILTER_OPERATOR UNSUPPORTED_TEXT_COMPARISON INVALID_FILTER_VALUE INVALID_ENUM_VALUE AMBIGUOUS_ENUM_VALUE
message
required
string
suggestions
Array<string>
key
additional properties
any
Examples
Examplemissing_scope
{
"error": "SCOPE_REQUIRED",
"message": "This endpoint requires the creator scope."
}