Retrieve Inventory

get

https://api.spyne.ai/api/pv1/enterprise/inventory/list/v2

Returns a paginated list of vehicles for an enterprise and team, drawn from the inventory search index.

sort_by, created_at and updated_at are JSON objects passed as query parameters — send them URL-encoded, for example sort_by={"creation_epoch":"desc"}.

The response body is returned exactly as the inventory service produces it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

enterprise_id

string

required

The enterprise to list inventory for.

team_id

string

required

The team (rooftop) to list inventory for. Must belong to the enterprise, or the request is rejected with 400.

page

integer

required

1-based page number.

per_page

integer

required

Number of records per page.

sort_by

json

Sort order, as {"creation_epoch": "asc"} or {"creation_epoch": "desc"}. "Note": creation_epoch is the only supported sort key.

created_at

json

Creation-date window, as {"from": "YYYY-MM-DD", "to": "YYYY-MM-DD"}. Both keys are required when this parameter is used. "Note": there is a known issue where the two bounds are applied in reverse, so a normal from ≤ to window currently matches nothing. Track this before relying on the filter.

updated_at

json

Update-date window, as {"from": "YYYY-MM-DD", "to": "YYYY-MM-DD"}. Both keys are required when supplied. "Note": there is a known issue where the two bounds are applied in reverse, so a normal from ≤ to window currently matches nothing. Track this before relying on the filter.

is_sold

boolean

Restrict the list to sold (true) or unsold (false) vehicles. Omit to include both.

Responses

200Inventory page retrieved.

400A required parameter is missing, a JSON filter is malformed, or the enterprise/team pair is invalid.

401Missing or invalid credential. Emitted by the auth layer, and shaped differently to the other errors.

500Unexpected error, or the inventory service was unreachable.