Skip to main content
GET
/
shops
/
{shopId}
/
services
List shop services
curl --request GET \
  --url https://api.guile.app/shops/{shopId}/services \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "name": "Skin Fade",
      "visibility": "visible",
      "bundledAddOns": [
        {
          "id": "service-123",
          "name": "Beard Trim"
        }
      ],
      "categories": [
        {
          "id": "afada02b-e9fe",
          "name": "Shaving"
        }
      ],
      "description": "Expertly transitioned fade with optional designs on the side.",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "duration": "PT30M",
      "cost": "45.00",
      "addOn": {
        "duration": "PT30M",
        "cost": "45.00"
      },
      "ageRestrictions": {
        "min": 18,
        "max": 100
      }
    }
  ],
  "count": 1
}

Path Parameters

​
shopId
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Query Parameters

​
name
string

Filter services by their name. This filter is case-insensitive and supports partial matches.

​
categories
object[]

Filter services to only include those with the these service categories. When excluded, services are not filtered by category.

​
type
enum<string>[]

Filter services to only include those with the these service types. When excluded, services are not filtered by type.

The type of a service.

Available options:
base,
addOn,
bundle
​
visibility
enum<string>[]

Filter services by visibility.

The visibility of a resource.

Available options:
visible,
hidden

Response

Ok. The operation succeeded.

A list response for resources. This response contains the full result set after any filters are applied.

​
items
object[]
required
​
count
integer<int16>
required
Required range: x >= 0