Tire Guru
Default module

Employee

Endpoint:https://api.prod.tireguru.net

Get Employees

GET
https://api.prod.tireguru.net
/api/v1/employees

This endpoint provides a comprehensive set of parameters to tailor your query. You can filter employees based on first name, last name, job description, phone number, active status and shop id. Additionally, you can include related data such as time clock and schedule information. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the employee data.

Get Employees › query Parameters

  • with_detailsboolean

    Include extra details in the response. This will add time clock and appointment details to every employee.

    Include extra details in the response. This will add time clock and appointment details to every employee.

    Example: null
  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -first_name. Sortable field: first_name, last_name, number, date_hired.

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -first_name. Sortable field: first_name, last_name, job_description and phone.

    Example: null
  • employee_idinteger

    Filter by employee id.

    Filter by employee id.

    Example: null
  • filter[first_name]string

    Filter by employees first name.

    Filter by employees first name.

    Example: null
  • filter[last_name]string

    Filter by employees last name.

    Filter by employees last name.

    Example: null
  • filter[job_description]string

    Filter by employees job description.

    Filter by employees job description.

    Example: null
  • filter[phone]string

    Filter by employees phone number.

    Filter by employees phone number.

    Example: null
  • filter[shop_id]string

    Primary key of the shop. If not provided, all locations within the company will be included.

  • activeboolean

    Filter by active status.

    Filter by active status.

    Example: null
  • pagestring

    Page number to return.

    Page number to return.

    Example: 1
  • pageSizestring

    Number of items to return in a page. Defaults to 10.

    Number of items to return in a page. Defaults to 10.

    Example: null

Get Employees › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

  • Acceptstring

Get Employees › Responses

  • dataobject[] · required
  • linksobject · required
  • metaobject · required

Create Employee

POST
https://api.prod.tireguru.net
/api/v1/employees

You can create a new Employee from here.

Create Employee › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create Employee › Request Body

  • shop_idnumber · required
  • employee_numberstring · required

    This must be unique across the company

    Example: JD123
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phonestring
    Example: 1234567899
  • emailstring | null
  • job_descriptionstring
  • date_hiredstring
    Example: 2024-07-09T08:35:25.394Z
  • default_writerboolean

    Is this the default salesperson?

    Default: false
  • activeboolean
    Default: true
  • hourly_ratenumber
    Example: 22.5
  • pinstring
    Example: 1234
  • company_accessboolean

    Does this employee have access to all locations within the company?

  • notesstring
    Example: Great hire!

Create Employee › Responses

  • employee_idnumber · required
  • shop_idnumber · required
  • employee_numberstring · required

    This must be unique across the company

    Example: JD123
  • payment_typestring · required
  • commissionstring · required
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phonestring
    Example: 1234567899
  • emailstring | null
  • job_descriptionstring
  • date_hiredstring
    Example: 2024-07-09T08:35:25.394Z
  • default_writerboolean

    Is this the default salesperson?

    Default: false
  • activeboolean
    Default: true
  • hourly_ratenumber
    Example: 22.5
  • pinstring
    Example: 1234
  • company_accessboolean

    Does this employee have access to all locations within the company?

  • notesstring
    Example: Great hire!

Update Employee

PUT
https://api.prod.tireguru.net
/api/v1/employees/{id}

Update an existing Employee from here.

Update Employee › path Parameters

  • idstring · required

Update Employee › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Employee › Request Body

  • shop_idnumber · required
  • employee_numberstring · required

    This must be unique across the company

    Example: JD123
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phonestring
    Example: 1234567899
  • emailstring | null
  • job_descriptionstring
  • date_hiredstring
    Example: 2024-07-09T08:35:25.394Z
  • default_writerboolean

    Is this the default salesperson?

    Default: false
  • activeboolean
    Default: true
  • hourly_ratenumber
    Example: 22.5
  • pinstring
    Example: 1234
  • company_accessboolean

    Does this employee have access to all locations within the company?

  • notesstring
    Example: Great hire!

Update Employee › Responses

  • employee_idnumber · required
  • shop_idnumber · required
  • employee_numberstring · required

    This must be unique across the company

    Example: JD123
  • payment_typestring · required
  • commissionstring · required
  • timestampstring · required
    Example: 2024-07-09T08:35:25.394Z
  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • addressstring
    Example: 123 w 123 n
  • citystring
    Example: Logan
  • statestring
    Example: Utah
  • zipstring
  • phonestring
    Example: 1234567899
  • emailstring | null
  • job_descriptionstring
  • date_hiredstring
    Example: 2024-07-09T08:35:25.394Z
  • default_writerboolean

    Is this the default salesperson?

    Default: false
  • activeboolean
    Default: true
  • hourly_ratenumber
    Example: 22.5
  • pinstring
    Example: 1234
  • company_accessboolean

    Does this employee have access to all locations within the company?

  • notesstring
    Example: Great hire!
CustomerInventory