Skip to main content
GET
Get a search

Authorizations

Authorization
string
header
required

An API key created in the PartFinder console at https://console.partfinder.dev, or a customer key created with POST /v1/keys. Send as Authorization: Bearer <key>. Revocation takes effect within approximately one minute.

Path Parameters

id
string<uuid>
required

The search id.

Response

The search.

as_of
string<date-time>
required

ISO 8601. How current the data in this response is.

summary
string
required

Plain language an agent can relay without re-deriving it.

notice
string
required

Informational-use notice. Always present.

id
string<uuid>
required
status
enum<string>
required

processing until the search ends; complete with its rows; failed when it could not be completed (submit it again).

Available options:
processing,
complete,
failed
query
string
required

The query you sent.

created_at
string<date-time>
required
completed_at
string<date-time> | null
required

When the search ended. Null while processing.

columns
string[]
required

The specification names every row's specs uses, chosen for what was searched. Empty until complete.

rows
object[]
required

The parts found. Empty until complete, and when nothing matched.

insights
object | null
required

A short reading of the results. Null while processing, or when there is none.