Skip to main content
GET
Get a comparison

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 comparison id.

Response

The comparison.

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 comparison ends; complete with its parts; failed when it could not be completed (submit it again).

Available options:
processing,
complete,
failed
created_at
string<date-time>
required
completed_at
string<date-time> | null
required

When the comparison ended. Null while processing.

columns
string[]
required

The specification names every part's specs and verdicts use. Empty until the comparison is complete, and also when the reference has nothing to be compared with.

parts
object[]
required

The reference first, then the parts compared with it. Empty until the comparison is complete; a completed comparison of a part with no alternates carries the reference alone.