> ## Documentation Index > Fetch the complete documentation index at: https://docs.guile.app/llms.txt > Use this file to discover all available pages before exploring further. # List recurring appointments > List recurring appointment series for a barber. When a customer filter is supplied, only series tied to that customer are returned. ## OpenAPI ````yaml /api-reference/Appointments/openapi.yaml get /barbers/{barberId}/recurringAppointments openapi: 3.0.0 info: title: Appointments version: 0.1.0 contact: name: Guile Engineering url: https://www.guile.app email: engineering@guile.app license: name: MIT url: https://opensource.org/license/mit description: Appointment management servers: - url: https://api.guile.app variables: {} - url: https://guile.fly.dev variables: {} security: [] tags: - name: Recurring appointments description: Create and manage repeating visit series - name: Appointment management description: Barber-side confirm, decline, and cancel flows - name: Appointments description: Book, change, pay, and cancel visits paths: /barbers/{barberId}/recurringAppointments: get: tags: - Recurring appointments summary: List recurring appointments description: >- List recurring appointment series for a barber. When a customer filter is supplied, only series tied to that customer are returned. operationId: listRecurringAppointments parameters: - name: barberId in: path required: true schema: $ref: '#/components/schemas/resourceId' - name: customerId in: query required: false description: Filter recurring appointments by customer ID. schema: $ref: '#/components/schemas/resourceId' explode: false responses: '200': description: |- Ok. The operation succeeded. content: application/json: schema: $ref: '#/components/schemas/recurringAppointments' '400': description: >- Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/badRequest](https://docs.guile.app/problems/badRequest) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '401': description: >- Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/unauthorized](https://docs.guile.app/problems/unauthorized) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '403': description: >- Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/forbidden](https://docs.guile.app/problems/forbidden) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '404': description: >- Not Found. There is no such resource at the request URL. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/notFound](https://docs.guile.app/problems/notFound) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '422': description: >- Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/unprocessableEntity](https://docs.guile.app/problems/unprocessableEntity) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '429': description: >- Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/tooManyRequests](https://docs.guile.app/problems/tooManyRequests) headers: Retry-After: required: true description: The number of seconds to wait before retrying the request. schema: type: integer format: uint32 content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' security: - BearerAuth: [] components: schemas: resourceId: type: string description: >- 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. recurringAppointments: type: object required: - items - count properties: items: type: array items: $ref: '#/components/schemas/recurringAppointmentItem' minItems: 0 count: type: integer format: int16 minimum: 0 description: A list of recurring appointments. apiProblem: type: object required: - type - title - occurredAt - id - status properties: type: allOf: - $ref: '#/components/schemas/uri' description: A URI reference that identifies the problem type. title: type: string maxLength: 120 description: >- A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. occurredAt: type: string format: date-time description: >- The date-time when this problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. detail: type: string maxLength: 256 description: >- A human-readable explanation specific to this occurrence of the problem. id: allOf: - $ref: '#/components/schemas/resourceId' description: >- The unique identifier for this problem. This is an immutable opaque string. status: allOf: - $ref: '#/components/schemas/statusCode' description: >- The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6)for this occurrence of the problem. instance: allOf: - $ref: '#/components/schemas/uri' maxLength: 2048 description: >- A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment. attributes: type: object additionalProperties: {} description: >- Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. recovery: allOf: - $ref: '#/components/schemas/clientFailureRecovery' description: The recovery contract for this problem occurrence. problems: type: array items: $ref: '#/components/schemas/problem' maxItems: 128 description: |- Optional root-causes if there are multiple problems in the request or API call processing. description: >- API problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457). recurringAppointmentItem: type: object required: - frequency - startDate - active - customerReference - id - barber - location - services - createdAt - updatedAt properties: frequency: allOf: - $ref: '#/components/schemas/frequency' description: >- The frequency at which appointments recur. Appointments are created in the background by the system based on this frequency. startDate: allOf: - $ref: '#/components/schemas/date' format: date description: |- The start date for the recurring appointment series. Appointments will be created starting from this date. endDate: allOf: - $ref: '#/components/schemas/date' format: date description: >- The end date for the recurring appointment series, if specified. If not specified, appointments are created up to one year from the start date or current date, whichever is later. active: type: boolean description: |- Whether the recurring appointment is active. When inactive, no new appointments will be created for this series. customerReference: allOf: - $ref: '#/components/schemas/Common.CustomerReference' description: >- A reference to the customer for this recurring appointment. Its `surname` is omitted when the customer limits barber visibility to the surname initial. id: allOf: - $ref: '#/components/schemas/resourceId' description: The unique identifier for this recurring appointment. barber: allOf: - $ref: '#/components/schemas/Common.BarberReference' description: A reference to the barber for this recurring appointment. location: allOf: - $ref: '#/components/schemas/Common.ShopLocationReference' description: The location for appointments in this series. services: type: array items: $ref: '#/components/schemas/Common.ServiceReference' description: The services for appointments in this series. displayName: type: string description: >- The customer name the authenticated barber may display. Under initial-only visibility, this contains the given name and surname initial, never the full surname. createdAt: type: string format: date-time description: |- The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. updatedAt: type: string format: date-time description: |- The date-time when this resource was updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. description: A summary representation of a recurring appointment. uri: type: string maxLength: 1024 format: uri description: A URI reference to an internal or external resource. statusCode: type: integer format: uint16 minimum: 100 maximum: 599 description: The HTTP status code for a response. clientFailureRecovery: type: object required: - outcome - retry properties: outcome: allOf: - $ref: '#/components/schemas/clientFailureOutcome' description: The known outcome of the request. retry: allOf: - $ref: '#/components/schemas/clientRetryDirective' description: The safe retry action for the request. sessionAction: allOf: - $ref: '#/components/schemas/clientSessionAction' description: The session action required before the request can continue. rateLimit: allOf: - $ref: '#/components/schemas/rateLimit' description: The rate limit state that prevented the request. description: The recovery contract for a failed client request. problem: type: object required: - type - title - occurredAt - id - status properties: type: allOf: - $ref: '#/components/schemas/uri' description: A URI reference that identifies the problem type. title: type: string maxLength: 120 description: >- A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. occurredAt: type: string format: date-time description: >- The date-time when this problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. detail: type: string maxLength: 256 description: >- A human-readable explanation specific to this occurrence of the problem. id: allOf: - $ref: '#/components/schemas/resourceId' description: >- The unique identifier for this problem. This is an immutable opaque string. status: allOf: - $ref: '#/components/schemas/statusCode' description: >- The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6)for this occurrence of the problem. instance: allOf: - $ref: '#/components/schemas/uri' maxLength: 2048 description: >- A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment. attributes: type: object additionalProperties: {} description: >- Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. description: >- Standard problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457). frequency: type: string enum: - daily - weekly - biweekly - semimonthly - monthly - quarterly - annually description: Recurring time denominations. date: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- A date, expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. Common.CustomerReference: type: object required: - id - givenName properties: id: allOf: - $ref: '#/components/schemas/resourceId' description: The unique identifier for the customer. givenName: type: string minLength: 1 maxLength: 55 format: text description: The given name of the customer. surname: type: string minLength: 1 maxLength: 55 format: text description: The surname of the customer, if known. description: |- A reference to a customer. This contains a subset of properties for the customer. Common.BarberReference: type: object required: - id - givenName - surname properties: id: allOf: - $ref: '#/components/schemas/resourceId' description: The unique identifier of the barber profile. givenName: type: string minLength: 1 maxLength: 55 format: text description: The given name of the barber. surname: type: string minLength: 1 maxLength: 55 format: text description: The surname of the barber. preferredName: type: string maxLength: 55 format: text description: The preferred name of the barber. biography: type: string maxLength: 2000 format: text description: A short biography of the barber. spokenLanguages: type: array items: $ref: '#/components/schemas/spokenLanguageTag' minItems: 1 description: Languages the barber speaks, as IETF BCP 47 language tags. experience: type: integer format: int32 minimum: 0 maximum: 100 description: |- Years of professional barbering experience. Omitted when the barber has not set a value. instagram: type: string minLength: 1 maxLength: 30 pattern: ^[A-Za-z0-9](?:[A-Za-z0-9._]{0,28}[A-Za-z0-9])?$ description: |- Public Instagram username for the booking page, without a leading @. Absent when unset. Not a private messaging channel. urlSlug: allOf: - $ref: '#/components/schemas/bookingSlug' description: The barber's public booking slug, used in profile links. profileImage_URL: type: string maxLength: 255 format: uri description: A URL to the barber's profile image. description: |- A reference to a barber resource. This contains a subset of properties for the barber. Use Barber for the full resource entity. Common.ShopLocationReference: type: object required: - id - name - shopName properties: id: allOf: - $ref: '#/components/schemas/resourceId' description: |- The unique identifier for this shop location reference. This is an immutable opaque string. name: type: string description: The name of this location for a shop. shopName: type: string description: The name of the shop business entity. description: |- A reference to a shop location. This contains a subset of properties for the location. Use ShopLocation for the full resource entity. Common.ServiceReference: type: object required: - id properties: id: allOf: - $ref: '#/components/schemas/resourceId' description: The unique identifier for the service. name: type: string description: The display name for this service. cost: allOf: - $ref: '#/components/schemas/money' description: The cost of the service, excluding any fees or taxes. duration: type: string format: duration description: The duration of the service. description: |- A reference to a service resource. This contains a subset of properties for the service. Use Service for the full resource entity. clientFailureOutcome: type: string enum: - notApplied - unknown description: The known outcome of a failed client request. clientRetryDirective: type: string enum: - doNotRetry - retrySameRequest - retrySameRequestAfterDelay description: The safe retry action for a failed client request. clientSessionAction: type: string enum: - refresh - signIn description: The session action required before a failed request can continue. rateLimit: type: object required: - limit - remaining - resetsAt properties: limit: type: integer format: uint64 description: The maximum number of requests allowed in the active window. remaining: type: integer format: uint64 description: The number of requests remaining in the active window. resetsAt: type: string format: date-time description: >- The date-time when the active window resets, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. description: The rate limit state for the request. spokenLanguageTag: type: string enum: - ar - de - en - es - fr - ko - ru - tl - vi - zh description: An IETF BCP 47 language tag supported on barber profiles. bookingSlug: type: string minLength: 3 maxLength: 40 pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$ description: A barber's public booking slug, used in profile links. money: type: string pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$ format: decimal description: >- A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision. Values may be positive or negative. example: '456.78' securitySchemes: BearerAuth: type: http scheme: Bearer ````