Service

Get Service

Get the data for a specified Service.

get/appointments/services/{service_id}

Request

  • Base URL
    https://api.wodify.com/v1
  • URL
    https://api.wodify.com/v1/appointments/services/{service_id}
  • Auth
    none declared. Required headers: x-api-key

Path parameters

service_idinteger required

Id of the Service to get data for

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Automations → Integrations page.

Response

Service Data

idinteger

Id of the Service

namestring

Name of the service

descriptionstring

Description of the service

service_icon_idinteger required

Id of the Icon that represents the Service

service_iconstring

Service Icon that represents the Service

hex_colorstring

Hex Color of the Service

attendance_limitinteger

The number of Clients that attend an Appointment together for this Service

has_free_intro_limitboolean

True if Free Intro limit is enabled

free_intro_limitinteger

Free Intro limit number

bookings_open_time_windowinteger

Window of time that bookings open for the Service

bookings_open_time_window_unit_of_time_idinteger

Unit of Time Id for the Bookings Open Time Window

bookings_open_time_window_unit_of_timestring

Unit of Time for the Bookings Open Time Window

bookings_close_time_windowinteger

Window of time that bookings close for the Service

bookings_close_time_window_unit_of_time_idinteger

Unit of Time Id for the Bookings Closes Time Window

bookings_close_time_window_unit_of_timestring

Unit of Time for the Bookings Close Time Window

buffer_timeinteger

Buffer Time between Appointments for the Service

appointments_can_start_at_00boolean

Indicates that the service can start at the beggining of the hour (minute 0)

appointments_can_start_at_05boolean

Indicates that the service can start at the minute 5

appointments_can_start_at_10boolean

Indicates that the service can start at the minute 10

appointments_can_start_at_15boolean

Indicates that the service can start at minute 15

appointments_can_start_at_20boolean

Indicates that the service can start at the minute 20

appointments_can_start_at_25boolean

Indicates that the service can start at the minute 25

appointments_can_start_at_30boolean

Indicates that the service can start at minute 30

appointments_can_start_at_35boolean

Indicates that the service can start at the minute 35

appointments_can_start_at_40boolean

Indicates that the service can start at the minute 40

appointments_can_start_at_45boolean

Indicates that the service can start at minute 45

appointments_can_start_at_50boolean

Indicates that the service can start at the minute 50

appointments_can_start_at_55boolean

Indicates that the service can start at the minute 55

is_activeboolean

Determines if the Service is active

Example response

{
  "id": 1234567891234567,
  "service_icon_id": 1234567891234567,
  "durations": [
    {
      "id": 1234567891234567
    }
  ],
  "cancellation_policy": {
    "cancellation_unit_of_time_id": 1234567891234567,
    "cancellation_fee": 0.1,
    "cancellation_fee_tax_rate_id": 1234567891234567
  },
  "no_show_policy": {
    "no_show_fee": 0.1,
    "no_show_fee_tax_rate_id": 1234567891234567
  },
  "location_providers": [
    {
      "id": 1234567891234567,
      "location_id": 1234567891234567,
      "providers": [
        {
          "provider_id": 1234567891234567
        }
      ]
    }
  ],
  "bookings_open_time_window_unit_of_time_id": 1234567891234567,
  "bookings_close_time_window_unit_of_time_id": 1234567891234567,
  "waivers": [
    {
      "waiver_id": 1234567891234567
    }
  ],
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.