action onsched_get_consumer_v1_services { label: "List Services" description: "
Use this endpoint to List Services available at your business location and/or company. If not specified, the business location defaults to the primary business location. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.
" provider: onsched method: GET path: "/consumer/v1/services" encoding: json input: { type: "object" properties: { allLocations: { type: "boolean" } defaultService: { type: "boolean" } limit: { type: "integer" format: "int32" } locationId: { type: "string" } name: { type: "string" } offset: { type: "integer" format: "int32" } scope: { type: "string" enum: ["company", "location", "all"] } serviceGroupId: { type: "integer" format: "int32" } serviceId: { type: "string" } sortDescending: { type: "boolean" } sortOrder: { type: "string" enum: ["natural", "name"] } } additionalProperties: false } output: { type: "object" properties: { count: { type: "integer" format: "int32" } data: { type: "array" items: { type: "object" properties: { availability: { type: "object" properties: { fri: { type: "object" properties: { endTime: { type: "integer" format: "int32" } startTime: { type: "integer" format: "int32" } } additionalProperties: false } mon: { type: "object" additionalProperties: true } sat: { type: "object" additionalProperties: true } sun: { type: "object" additionalProperties: true } thu: { type: "object" additionalProperties: true } tue: { type: "object" additionalProperties: true } wed: { type: "object" additionalProperties: true } } additionalProperties: false } bookAheadUnit: { type: "integer" format: "int32" } bookAheadValue: { type: "integer" format: "int32" } bookInAdvance: { type: "integer" format: "int32" } bookingInterval: { type: "integer" format: "int32" } bookingLimit: { type: "integer" format: "int32" } calendarId: { type: "string" } calendarResourceGroupId: { type: "string" } cancellationFeeAmount: { type: "number" format: "double" } cancellationFeeTaxable: { type: "boolean" } companyId: { type: "string" } consumerPadding: { type: "boolean" } customFields: { type: "object" properties: { field1: { type: "string" } field10: { type: "string" } field2: { type: "string" } field3: { type: "string" } field4: { type: "string" } field5: { type: "string" } field6: { type: "string" } field7: { type: "string" } field8: { type: "string" } field9: { type: "string" } } additionalProperties: false } dailyBookingLimitCount: { type: "integer" format: "int32" } dailyBookingLimitMinutes: { type: "integer" format: "int32" } defaultService: { type: "boolean" } description: { type: "string" } duration: { type: "integer" format: "int32" } durationInterval: { type: "integer" format: "int32" } durationMax: { type: "integer" format: "int32" } durationMin: { type: "integer" format: "int32" } durationSelect: { type: "boolean" } feeAmount: { type: "number" format: "double" } feeTaxable: { type: "boolean" } id: { type: "string" } imageUrl: { type: "string" } locationId: { type: "string" } maxBookingLimit: { type: "integer" format: "int32" } maxCapacity: { type: "integer" format: "int32" } maxGroupSize: { type: "integer" format: "int32" } maxResourceBookingLimit: { type: "integer" format: "int32" } mediaPageUrl: { type: "string" } name: { type: "string" } nonRefundable: { type: "boolean" } object: { type: "string" } padding: { type: "integer" format: "int32" } roundRobin: { type: "integer" format: "int32" } serviceGroupId: { type: "integer" format: "int32" } serviceGroupName: { type: "string" } showOnline: { type: "boolean" } type: { type: "string" } } additionalProperties: false } } hasMore: { type: "boolean" } object: { type: "string" } total: { type: "integer" format: "int32" } url: { type: "string" } } additionalProperties: false } }