Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Get Service

Developer Preview

Retrieves a service, including all its data.

Permissions
This endpoint requires the Read Bookings - Public Data, the Read Bookings - Including Participants or the Manage Bookings permissions scope

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

GET

https://www.wixapis.com/bookings/v1/catalog/services/{id}

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

Service ID.

Query Params

NAME
TYPE
DESCRIPTION
fields

Array<string>

Field names to return in response (leave empty to get all fields).

Response Object

A full catalog detailed response containing all the information related to a service.

NAME
TYPE
DESCRIPTION
pricingPlans

Array<object>

All available pricing plans that can be used to book this service.

urls

object

URLs to directly access the service's information page, and the service's booking page in Wix Bookings.

schedules

Array<object>

Full schedule details of the service.

service

object

The service entity

status

string

Supported values: ACTIVE, DELETED.

Bookings service status.

resources

Array<object>

Resources associated with this service (e.g., the staff member teaching a class).

category

object

Category associated with the service.

form

object

Booking form used to get the customer's input while booking the service.

slugs

Array<object>

Slug of the service. This combined with the URL provides the full path to the service's page and booking page.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Get Catalog Service Fields

Returns the requested fields of the service entity.

Request

curl

Copy Code
1curl -X GET \
2 'https://www.wixapis.com/bookings/v1/catalog/services/4c0bae61-4599-4d02-a2f4-25e9222df416?fields=service.info.name&fields=service.id' \
3 -H 'Authorization: <AUTH>'

Response

json

1
2{
3 "service": {
4 "id": "4c0bae61-4599-4d02-a2f4-25e9222df416",
5 "info": {
6 "name": "Haircut",
7 "images": []
8 },
9 "scheduleIds": [],
10 "customProperties": {},
11 "status": "CREATED"
12 },
13 "pricingPlans": [],
14 "resources": [],
15 "schedules": [],
16 "slugs": [],
17 "status": "ACTIVE"
18}
Get Catalog Service