GET Vehicles

This endpoint allows you to retrieve a paginated and filtered list of vehicles from the Sync platform. You can filter by multiple criteria including identification fields, vehicle details, and processing status for various resources.

This endpoint retrieves vehicles from the Sync platform with support for advanced filtering, pagination, and sorting capabilities.

Request

HTTP request

GET https://api-sync-resser.azurewebsites.net/api/vehicles

Parameters

The following table lists the parameters that this query supports. All parameters are optional query parameters unless specified otherwise.

Vehicle Identification

Parameter	Type	Max Length	Description
customId	string	50	Vehicle's customId
plate	string	15	Vehicle's plate
vin	string	17	Vehicle Identification Number (VIN)

Vehicle Details

Parameter	Type	Max Length	Description
stateId	integer	-	Filter by state/region ID. For a complete list of valid IDs, refer to the Available States reference.
assetStatusId	integer	-	Filter by vehicle status ID. For a complete list of valid IDs, refer to the Vehicle Statuses reference.
rfcName	string	300	RFC name of the vehicle owner
taxIdentifier	string	128	Tax identifier of the vehicle owner
lessorName	string	300	Name of the lessor/leasing company
brandName	string	150	Vehicle brand/make
modelName	string	150	Vehicle model
country	string	150	Country of registration
class	string	150	Vehicle class
type	string	150	Vehicle type
doors	integer	-	Number of doors (0-30)
variation	string	150	Vehicle variation
cilinders	string	150	Number of cylinders
axes	string	150	Number of axes
vehicleColor	string	150	Vehicle color
version	string	50	Vehicle version
assemblyPlace	string	150	Place where vehicle was assembled
supplementaryData	string	150	Additional supplementary data
registrationInstitution	string	150	Registration institution
plateEntity	string	50	Entity/state of plate registration
registrationSheet	string	150	Registration sheet number
observations	string	150	General observations about the vehicle
ownerName	string	150	Name of the vehicle owner
engineNumber	string	50	Engine number
year	integer	-	Manufacturing year (1950-current year+1)

Resource Status Filters

Filter vehicles by their processing status in different Sync resources. Each status field accepts integer values.

Parameter	Type	Description
stolenStatus	integer	Stolen vehicle verification status
tenenciaStatus	integer	Property tax (Tenencia) status
ticketStatus	integer	Traffic tickets status
insuranceStatus	integer	Insurance verification status
cardStatus	integer	Circulation card status
miscStatus	integer	Miscellaneous status
repuveStatus	integer	REPUVE registry status
ticketsCDMXStatus	integer	Mexico City tickets status
ticketsEnvStatus	integer	Environmental tickets status
refrendoStatus	integer	License renewal (Refrendo) status
inspectionStatus	integer	Vehicle inspection status
violationStatus	integer	Traffic violations status
plateStatus	integer	License plate status

Status Values

Vehicle processing uses explicit status IDs to reflect their current state. Please refer to the Available Statuses reference for the complete list of status meanings and definitions.

Pagination and Sorting

Parameter	Type	Required	Default	Description
page	integer	No	1	Page number (must be ≥ 1)
pageSize	integer	No	10	Results per page (1-100)
sortOrder	integer	No	0	Sort order: 0 = Ascending, 1 = Descending
sortBy	string	No	customId	Field to sort by. Valid values: customId, plate, vin, rfcName, lessorName, taxIdentifier, brandName, modelName, country, class, type, doors, variation, cilinders, axes, vehicleColor, version, assemblyPlace, registrationInstitution, plateEntity, registrationSheet, ownerName, engineNumber, year

Response

If successful, the method returns a paginated list of matching vehicles:

{
	"data": [
		{
			"customId": "306705",
			"vin": "3BKHLN9X0FF306705",
			"plate": "RJ41853",
			"stateId": 19,
			"stateName": "Nuevo León",
			"brandName": "KIA",
			"modelName": "RIO",
			"year": 2019,
			"assetStatusId": 1
			// ... other detailed vehicle fields
		}
	],
	"pagination": {
		"currentPage": 1,
		"pageSize": 10,
		"totalCount": 1,
		"totalPages": 1,
		"hasPrevious": false,
		"hasNext": false,
		"sortBy": "customId",
		"sortOrder": "asc"
	}
}

Property	Type	Description
data	array	Array of vehicle objects
pagination	object	Pagination and sorting metadata

Pagination Metadata

The following fields are returned inside the pagination object in the API response to help you navigate through the records.

Field	Type	Description
currentPage	integer	Current page number
pageSize	integer	Number of results per page
totalCount	integer	Total number of records matching the filters
totalPages	integer	Total number of available pages
hasPrevious	boolean	Indicates whether a previous page exists
hasNext	boolean	Indicates whether a next page exists
sortBy	string	Field used to sort results
sortOrder	string	Sort direction (asc or desc)

Vehicle Object

The following fields are returned for each vehicle inside the data array.

Field	Type	Description
customId	string	Vehicle custom identifier
vin	string	Vehicle Identification Number (VIN)
plate	string	Vehicle plate number
stateId	integer	State/region identifier. See Available States reference.
stateName	string	State/region name
rfcName	string	RFC name associated with the vehicle
taxIdentifier	string	Tax identifier associated with the vehicle
lessorName	string	Name of the lessor/leasing company
brandName	string	Vehicle brand/make
modelName	string	Vehicle model
year	integer	Manufacturing year
assetStatusId	integer	Vehicle asset status identifier. See Vehicle Statuses reference.
axes	string	Number of axes
class	string	Vehicle class
type	string	Vehicle type
doors	integer	Number of doors
country	string	Country of registration
variation	string	Vehicle variation
cilinders	string	Engine cylinder configuration
vehicleColor	string	Vehicle color
version	string	Vehicle version
engineNumber	string	Engine number
plateEntity	string	State/entity where the plate was registered
plateDate	string	Vehicle plate registration date in ISO 8601 format
assemblyPlace	string	Place where the vehicle was assembled
observations	string	General observations related to the vehicle
registrationDate	datetime	Vehicle registration date
registrationInstitution	string	Registration institution
registrationSheet	string	Registration sheet/reference number
supplementaryData	string	Additional supplementary information
ownerName	string	Vehicle owner name
tags	array	Collection of tags associated with the vehicle
statusSummary	object	Summary object containing the latest processing statuses for different vehicle validations and services

Status Summary Object

Status Summary Freshness

The values returned inside the statusSummary object are cached summary statuses used by the Sync platform for quick visualization and filtering purposes.

These statuses are only updated when a vehicle is processed directly through the Sync platform. Because of this, the values may not always reflect the latest available vehicle information.

If a vehicle was processed externally, imported manually, or contains historical records that have not been synchronized through the Sync processing flow, the statusSummary values may be outdated or incomplete.

To retrieve the latest real-time vehicle information (tickets, violations, tenencia, inspections, REPUVE, etc.), please consult the corresponding scraping endpoints available in the Scraped Information category.

The statusSummary object contains summarized processing statuses for different services and validations.

Status Values

Vehicle processing uses explicit status IDs to represent the current processing state of each service or validation.

Please refer to the Available Statuses reference for the complete list of status definitions and meanings.

Field	Type	Description
cardStatus	integer	Vehicle card/document status
insuranceStatus	integer	Insurance validation status
miscStatus	integer	Miscellaneous validation status
refrendoStatus	integer	Refrendo/payment validation status
stolenStatus	integer	Stolen vehicle validation status
repuveStatus	integer	REPUVE validation status
tenenciaStatus	integer	Tenencia validation status
ticketStatus	integer	Traffic tickets validation status
ticketsCDMXStatus	integer	Mexico City traffic tickets validation status
ticketsEnvStatus	integer	Environmental tickets validation status
inspectionStatus	integer	Vehicle inspection status
violationStatus	integer	Violations validation status
plateStatus	integer	Plate validation status

Errors

The following table provides a list of potential error messages that the API may return in response to a call to this method. For more detailed information, please refer to the error message documentation.

Error Type	Error Detail	Description
badRequest (400)	BadRequest	- Invalid parameter values (exceeds max length, invalid type) - page must be ≥ 1 - pageSize must be between 1-100 - sortOrder must be 0 or 1 - year must be between 1950 and current year+1 - doors must be between 0-30 - Invalid sortBy value - Invalid status field value (must be a valid status ID from the statuses reference). - Invalid assetStatusId value (must be a valid status ID from the vehicle status reference).
unauthorized (401)	Unauthorized	The requester is not allowed to use this request.
forbidden (403)	Forbidden	Requester does not have permission to perform this operation.

Notes

• All string parameters are trimmed automatically
• Values passed to sortBy are case-insensitive
• Empty or null parameters are ignored
• Multiple filters can be combined to narrow down results
• Default assetStatusId is 1 (Active) if not specified
• Status values of -1 typically indicate "unprocessed" state in that resource