Employee entity

Read dealership employees with profile images, contact fields, public profile fields, and nested employee department summaries.

#Endpoints

Employee records represent team members shown or assigned across dealership workflows. Responses include the employee department summary.

GET/v1/employees

GET/v1/employees/{id}

Auth

Send the dealership API key in the x-api-key header.

Detail IDs

Detail routes use the UUID returned by the corresponding list endpoint.

Dates

Date fields and date filters use ISO 8601 timestamps.

#Filters and Limits

List endpoints share the same pagination envelope. Query booleans use true or false.

Parameter	Type	Required	Notes
limit	number	No	Number of records to return. Defaults to `100`. Maximum is `500`.
offset	number	No	Number of records to skip. Defaults to `0`.
search	string	No	Optional text search. Searchable fields are listed on each entity.
createdAfter	datetime	No	Return records created at or after an ISO 8601 timestamp.
createdBefore	datetime	No	Return records created at or before an ISO 8601 timestamp.
updatedAfter	datetime	No	Return records updated at or after an ISO 8601 timestamp.
updatedBefore	datetime	No	Return records updated at or before an ISO 8601 timestamp.
departmentId	uuid	No	Filter by employee department ID.

Entity filters

Common list filters plus departmentId and search.

Search fields

name, position, email, and phoneNumber.

Default sort

sortIndex ascending, then id ascending.

JSON

{
  "data": [],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 0
  }
}

#Response

Field	Type	Nullable	Notes
id	uuid	No	Employee ID.
name	string	No	Employee name.
position	string	No	Job title or position.
slug	string	No	Public profile slug.
sortIndex	number	No	Display order within the department.
email	string	Yes	Email address.
phoneNumber	string	Yes	Phone number.
speaksSpanish	boolean	Yes	Spanish-language flag.
bio	string	Yes	Employee biography.
profileImage	File	Yes	Profile image metadata.
department	EmployeeDepartmentSummary	Yes	Nested employee department summary.
createdAt	datetime	No	Creation timestamp.
updatedAt	datetime	No	Last update timestamp.

Fields

Includes identity, name, position, slug, contact fields, biography/social URLs, profile image, nested employee department summary, createdAt, and updatedAt.

#Example Request

Shell

curl "https://api.driverseat.io/v1/employees?search=sales" \
  -H "x-api-key: sk-driverseat-..."

#Errors

400

Invalid query parameter or resource ID. Common causes include a limit above 500, an invalid UUID, an invalid datetime, or an unsupported enum value.

401

The API key is missing, invalid, or revoked.

404

The requested employee does not exist or does not belong to the dealership authorized by the API key.