Tire Guru
Default module

Appointment

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

Get Appointment

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

This endpoint provides a comprehensive set of parameters to tailor your query. You can filter appointment based on first name, last name, vehicle year, vehicle make, vehicle model, appointment reason, schedule date and schedule time. Additionally, you can include related data such as customer and vehicle. The pagination options allow you to manage the number of items returned per page, facilitating smooth navigation through the appointment data.

Get Appointment › query Parameters

  • with_detailsboolean

    Include extra details in the response. This will add customer and vehicle details to every appointment.

    Include extra details in the response. This will add customer and vehicle details to every appointment.

    Example: null
  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Eg: -first_name. Sortable fields: first_name, last_name, timestamp, reason

    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, year, date and reason.

    Example: null
  • appointment_idinteger

    Filter by appointment id.

    Filter by appointment id.

    Example: null
  • filter[first_name]string

    Filter by appointment client first name.

    Filter by appointment client first name.

    Example: null
  • filter[last_name]string

    Filter by appointment client last name.

    Filter by appointment client last name.

    Example: null
  • filter[reason]string

    Filter by appointment reason.

    Filter by appointment reason.

    Example: null
  • filter[year]string

    Filter by appointment year.

    Filter by appointment year.

    Example: null
  • filter[make]string

    Filter by appointment vehicle make.

    Filter by appointment vehicle make.

    Example: null
  • filter[model]string

    Filter by appointment vehicle model.

    Filter by appointment vehicle model.

    Example: null
  • filter[date]string

    Filter by appointment schedule date.

    Filter by appointment schedule date.

    Example: null
  • filter[time]string

    Filter by appointment schedule time.

    Filter by appointment schedule time.

    Example: null
  • filter[status]string · enum

    Filter by appointment status. Defaults to both.

    Enum values:
    complete
    incomplete
    both
  • filter[updated_date]string

    Filter by last update date.

  • filter[shop_id]string

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

  • start_datestring

    Filter range by appointment schedule date. This will get every appointment from this date onwards.

    Filter range by appointment schedule date. This will get every appointment from this date onwards.

    Example: null
  • end_datestring

    Filter range by appointment schedule date. This will get every appointment from this date backwards.

    Filter range by appointment schedule date. This will get every appointment from this date backwards.

    Example: null
  • filter_bystring · enum

    Filter range field to filter by, if no value is passed, the created time will be used.

    Filter range field to filter by, if no value is passed, the created time will be used.

    Enum values:
    appointment_start
    appointment_end
    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 Appointment › 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.

Get Appointment › Responses

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

Create Appointment

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

This endpoint provides a way to create an Appointment.

Create Appointment › 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 Appointment › Request Body

  • shop_idnumber · required
  • datestring · required
    Example: 2024-07-09T08:35:25.394Z
  • yearstring · required
  • makestring · required
  • modelstring · required
  • home_phonestring · required
  • work_phonestring · required
  • cell_phonestring · required
  • customer_id

    Unique identifier of the customer

  • vehicle_id

    Unique identifier of the vehicle

  • repair_order_id

    Unique identifier of the repair order

  • employee_id

    Unique identifier of the employee

  • doneboolean

    Is this appointment already completed?

    Default: false
  • columnstring

    Name of the bay that this appointment is scheduled in

    Example: Oil Change Bay
  • reasonstring | null

    Reason for the appointment

    Example: Oil Chnage
  • statusstring | null

    The status of the associated work order (if linked)

  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • hoursnumber

    Duration of the appointment in hours

    Example: 2.5
  • email

    Customer information if customer_id is not provided

Create Appointment › Responses

  • appointment_idnumber · required
  • shop_idnumber
  • customer_id

    Unique identifier of the customer

  • vehicle_id

    Unique identifier of the vehicle

  • repair_order_id

    Unique identifier of the repair order

  • employee_id

    Unique identifier of the employee

  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • vehicleobject | null
  • reasonstring | null

    Reason for the appointment

    Example: Oil Chnage
  • phoneobject | null
  • hoursnumber

    Duration of the appointment in hours

    Example: 2.5
  • columnstring

    Name of the bay that this appointment is scheduled in

    Example: Oil Change Bay
  • doneboolean

    Is this appointment already completed?

    Default: false
  • email

    Customer information if customer_id is not provided

  • sourcestring | null · enum
    Enum values:
    Website
    Tire Link
    Mobile
    Appointment
    Call Center
    Customer Portal
    Mobile Van
    API
  • scheduleobject
  • timestampstring
    Example: 2024-07-09T08:35:25.394Z
  • updated_atstring | null
  • deletedstring | null
  • statusstring | null

    The status of the associated work order (if linked)

Update Appointment

PUT
https://api.prod.tireguru.net
/api/v1/appointments/{ID}

Update an existing Appointment from here.

Update Appointment › path Parameters

  • IDstring · required

Update Appointment › 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 Appointment › Request Body

  • shop_idnumber · required
  • datestring · required
    Example: 2024-07-09T08:35:25.394Z
  • yearstring · required
  • makestring · required
  • modelstring · required
  • home_phonestring · required
  • work_phonestring · required
  • cell_phonestring · required
  • customer_id

    Unique identifier of the customer

  • vehicle_id

    Unique identifier of the vehicle

  • repair_order_id

    Unique identifier of the repair order

  • employee_id

    Unique identifier of the employee

  • doneboolean

    Is this appointment already completed?

    Default: false
  • columnstring

    Name of the bay that this appointment is scheduled in

    Example: Oil Change Bay
  • reasonstring | null

    Reason for the appointment

    Example: Oil Chnage
  • statusstring | null

    The status of the associated work order (if linked)

  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • hoursnumber

    Duration of the appointment in hours

    Example: 2.5
  • email

    Customer information if customer_id is not provided

Update Appointment › Responses

  • appointment_idnumber · required
  • shop_idnumber
  • customer_id

    Unique identifier of the customer

  • vehicle_id

    Unique identifier of the vehicle

  • repair_order_id

    Unique identifier of the repair order

  • employee_id

    Unique identifier of the employee

  • first_namestring
    Example: John
  • last_namestring
    Example: Doe
  • vehicleobject | null
  • reasonstring | null

    Reason for the appointment

    Example: Oil Chnage
  • phoneobject | null
  • hoursnumber

    Duration of the appointment in hours

    Example: 2.5
  • columnstring

    Name of the bay that this appointment is scheduled in

    Example: Oil Change Bay
  • doneboolean

    Is this appointment already completed?

    Default: false
  • email

    Customer information if customer_id is not provided

  • sourcestring | null · enum
    Enum values:
    Website
    Tire Link
    Mobile
    Appointment
    Call Center
    Customer Portal
    Mobile Van
    API
  • scheduleobject
  • timestampstring
    Example: 2024-07-09T08:35:25.394Z
  • updated_atstring | null
  • deletedstring | null
  • statusstring | null

    The status of the associated work order (if linked)

Get Shop Bays

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

Get Shop Bays › query Parameters

  • 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
  • sortstring

    Sort by column, can be DESC or ASC. For DESC append a - next to the sort column. Sortable fields: title, order

  • filter[shop_id]string

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

Get Shop Bays › 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.

Get Shop Bays › Responses

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