Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Search

List search batches

List all search batches for the authenticated user's organization.

get/searches/batches

Query parameters

qstring nullable

Search query. Can be a batch ID (UUID) or batch name. If UUID, filters by exact ID match. Otherwise, filters by case-insensitive name match.

Search query. Can be a batch ID (UUID) or batch name. If UUID, filters by exact ID match. Otherwise, filters by case-insensitive name match.

limitinteger

Maximum number of records to return in a single page. Must be between 1 and 1000.

Maximum number of records to return in a single page. Must be between 1 and 1000.

offsetinteger nullable

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

cursorstring nullable

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

start_datestring date nullable

Filter records created on or after this date (format: YYYY-MM-DD).

Filter records created on or after this date (format: YYYY-MM-DD).

end_datestring date nullable

Filter records created on or before this date (format: YYYY-MM-DD).

Filter records created on or before this date (format: YYYY-MM-DD).

tzstring

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Example:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Response

List of search batches.

idstring uuid required

Unique identifier for the business search batch.

namestring required

The name of the business search batch.

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required
progressnumber nullable

Processing progress from 0.0 to 1.0. Null if not yet started.

completed_countinteger nullable

Number of rows that have been processed. Null if not yet started.

total_countinteger nullable

Total number of rows to process. Null if not yet started.

created_atstring date-time required

The datetime the business search batch was created.

optionsstring[]

Optional features to enable during business search execution.

warningsstring[]

Any warnings that occurred.

export_csv_uristring nullable

GCS URI for the pre-computed CSV export. Available after batch completion.

export_jsonl_uristring nullable

GCS URI for the pre-computed JSONL export. Available after batch completion.

report_versioninteger nullable

Report schema version. Available after batch completion.

Example response

[
  {
    "options": [
      "Order.WebsiteAnalysis"
    ],
    "questionnaire": {
      "kyb": {
        "current_provider": "Middesk",
        "new_applications_per_month": 500,
        "avg_uw_time_hours": 24,
        "avg_uw_time_minutes": 2,
        "match_rate_pct": 25,
        "approval_rate_pct": 72
      },
      "web_presence": {
        "current_provider": "Built in-house"
      },
      "liens": {
        "current_provider": "LexisNexis"
      },
      "litigations": {
        "current_provider": "LexisNexis"
      }
    }
  }
]