Dealership APIEmployee Department

Employee Department entity

Read employee department groups with nested employees for dealership team pages and assignments.

#Endpoints

Employee departments group employees for team organization. Responses include nested employee summaries.

GET/v1/employee-departments
GET/v1/employee-departments/{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.

ParameterTypeRequiredNotes
limitnumberNoNumber of records to return. Defaults to 100. Maximum is 500.
offsetnumberNoNumber of records to skip. Defaults to 0.
searchstringNoOptional text search. Searchable fields are listed on each entity.
createdAfterdatetimeNoReturn records created at or after an ISO 8601 timestamp.
createdBeforedatetimeNoReturn records created at or before an ISO 8601 timestamp.
updatedAfterdatetimeNoReturn records updated at or after an ISO 8601 timestamp.
updatedBeforedatetimeNoReturn records updated at or before an ISO 8601 timestamp.
Entity filters
Common list filters plus search.
Search fields
name
Default sort
sortIndex ascending, then id ascending.
JSON
{
  "data": [],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 0
  }
}

#Response

FieldTypeNullableNotes
iduuidNoEmployee department ID.
namestringNoDepartment name.
sortIndexnumberNoDisplay order.
employeesEmployeeSummary[]NoEmployees in this department.
createdAtdatetimeNoCreation timestamp.
updatedAtdatetimeNoLast update timestamp.
Fields
Includes id, name, sortIndex, nested employee summaries, createdAt, and updatedAt.

#Example Request

Shell
curl "https://api.driverseat.io/v1/employee-departments" \
  -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 department does not exist or does not belong to the dealership authorized by the API key.