> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zenamu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List workshops

> Returns your studio's publicly visible workshops for a date range.
Workshops are standalone events — seminars, intensives, retreats —
kept separate from the regular class schedule.

A workshop carries its **own address** rather than a reference to a
place, so this endpoint has no `placeIds` filter.

`dateFrom` and `dateTo` are required and are interpreted in your
studio's time zone. Results are ordered by start time, ascending, with
a deterministic ID tie-breaker. Canceled workshops are excluded.

See the [Workshop](/api/objects/workshop) object for the full field
reference.




## OpenAPI

````yaml /api/v1/openapi.yaml get /v1/workshops
openapi: 3.0.3
info:
  title: Zenamu API v1
  version: '1.0'
  description: The Zenamu public REST API.
servers:
  - url: https://api.zenamu.com
    description: Production
security:
  - zenamuPublicKey: []
tags:
  - name: Classes
  - name: Workshops
  - name: Lecturers
  - name: Places
  - name: Clients
  - name: Credits and passes
  - name: Pass groups
paths:
  /v1/workshops:
    get:
      tags:
        - Workshops
      summary: List workshops
      description: |
        Returns your studio's publicly visible workshops for a date range.
        Workshops are standalone events — seminars, intensives, retreats —
        kept separate from the regular class schedule.

        A workshop carries its **own address** rather than a reference to a
        place, so this endpoint has no `placeIds` filter.

        `dateFrom` and `dateTo` are required and are interpreted in your
        studio's time zone. Results are ordered by start time, ascending, with
        a deterministic ID tie-breaker. Canceled workshops are excluded.

        See the [Workshop](/api/objects/workshop) object for the full field
        reference.
      operationId: getWorkshops
      parameters:
        - name: dateFrom
          in: query
          required: true
          schema:
            type: string
            format: date
            example: '2026-03-01'
          description: >-
            Start of the range (inclusive), `YYYY-MM-DD`, read in the studio's
            time zone. Must be a real calendar date and no later than `dateTo`.
            The range may span at most 366 days, counting both ends. See [Dates
            and time zones](/api/dates).
        - name: dateTo
          in: query
          required: true
          schema:
            type: string
            format: date
            example: '2026-03-31'
          description: >-
            End of the range (inclusive), `YYYY-MM-DD`, read in the studio's
            time zone. Must be a real calendar date on or after `dateFrom`, and
            at most 366 days after it. The whole end day is included.
        - name: lecturerIds
          in: query
          schema:
            type: string
            example: 5,10
          description: Comma-separated numeric lecturer IDs.
        - name: labelIds
          in: query
          schema:
            type: string
            example: 8,12
          description: Comma-separated numeric label IDs.
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            example: 50
          description: >-
            Maximum number of records to return. See
            [Pagination](/api/pagination).
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            example: 0
          description: Number of records to skip. See [Pagination](/api/pagination).
        - name: includeCapacity
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
              - '1'
              - '0'
            default: 'false'
          description: >-
            Set to `true` or `1` to add the `capacity` object, which for
            workshops also reports `available` seats.
      responses:
        '200':
          description: The matching workshops.
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current one-minute window.
              schema:
                type: integer
                example: 100
            X-RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: integer
                minimum: 0
                example: 99
            X-RateLimit-Reset:
              description: Unix timestamp in seconds when the current window resets.
              schema:
                type: integer
                example: 1788336000
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkshopList'
              example:
                statusCode: 200
                message: Success
                data:
                  - _id: 6d3f90b25e814ca70f2db6913a5ce048
                    name: Weekend yoga retreat
                    shortDescription: Immersive weekend retreat in the mountains.
                    image: https://storage.zenamu.com/workshops/yoga-retreat.jpg
                    start: '2026-03-20T09:00:00Z'
                    end: '2026-03-22T17:00:00Z'
                    localTimeStart: '2026-03-20T10:00:00+01:00'
                    localTimeEnd: '2026-03-22T18:00:00+01:00'
                    timezone: Europe/Prague
                    lecturerIds:
                      - a05e73c81df946b20c3ea8175f6b4e92
                    address:
                      street: Mountain Road 123
                      city: Alpine Village
                      postalCode: '12345'
                      country: Switzerland
                    pricingOptions:
                      - id: 990
                        type: default
                        name: Full weekend
                        value: 450
                        currency: EUR
                    tags:
                      - id: 15
                        name: Retreat
                        color: '#9C27B0'
                    publicUrl: https://app.zenamu.com/your-studio/workshops/789
                    capacity:
                      max: 25
                      reserved: 18
                      available: 7
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/KeyNotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - zenamuPublicKey: []
components:
  schemas:
    WorkshopList:
      type: object
      properties:
        statusCode:
          type: integer
          example: 200
        message:
          type: string
          example: Success
        data:
          type: array
          items:
            $ref: '#/components/schemas/Workshop'
    Workshop:
      type: object
      properties:
        _id:
          type: string
          description: Opaque workshop ID.
          example: 6d3f90b25e814ca70f2db6913a5ce048
        name:
          type: string
        shortDescription:
          type: string
          nullable: true
        image:
          type: string
          nullable: true
          description: URL of the workshop image, or `null`.
        start:
          type: string
          format: date-time
          nullable: true
          description: Start in UTC.
        end:
          type: string
          format: date-time
          nullable: true
        localTimeStart:
          type: string
          nullable: true
          description: Start in the studio's time zone, with a numeric offset.
        localTimeEnd:
          type: string
          nullable: true
        timezone:
          type: string
          example: Europe/Prague
        lecturerIds:
          type: array
          items:
            type: string
        address:
          allOf:
            - $ref: '#/components/schemas/Address'
          nullable: true
          description: >-
            The workshop's own address, or `null` when the studio left every
            address field empty. Workshops do not reference a place.
        pricingOptions:
          type: array
          items:
            $ref: '#/components/schemas/WorkshopPricingOption'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        publicUrl:
          type: string
        capacity:
          $ref: '#/components/schemas/WorkshopCapacity'
    ErrorResponse:
      type: object
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: Repeats the HTTP status code.
        error:
          type: string
          description: >-
            Short label — `Internal Server Error` for `500`, `Too Many Requests`
            for `429`, `Error` otherwise.
        message:
          type: string
          description: >-
            Human-readable explanation. For `500` this is a fixed generic
            message; the detail is logged server-side.
    Address:
      type: object
      description: A postal address. Every field is independently nullable.
      properties:
        street:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        postalCode:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
    WorkshopPricingOption:
      type: object
      description: >-
        One way to pay for a workshop. Same shape as a class [pricing
        option](/api/objects/pricing-option) but without `description`.
      properties:
        id:
          type: integer
        type:
          type: string
          description: >-
            Same values as a class [pricing
            option](/api/objects/pricing-option#types). Treat the list as open
            and render an unknown `type` using `name`.
        name:
          type: string
          nullable: true
        value:
          type: number
        currency:
          type: string
          description: >-
            An ISO 4217 code for a money-based option. Absent for non-money
            options.
    Tag:
      type: object
      description: >-
        A studio label attached to an event. Embedded inline, not referenced by
        ID.
      properties:
        id:
          type: integer
          description: Numeric label ID. Pass it to the `labelIds` filter.
        name:
          type: string
        color:
          type: string
          description: Hex color chosen by the studio.
          example: '#4CAF50'
    WorkshopCapacity:
      type: object
      description: Present only when `includeCapacity` is requested.
      properties:
        max:
          type: integer
          description: Maximum number of participants. Every workshop has a seat limit.
        reserved:
          type: integer
        available:
          type: integer
          description: >-
            `max` minus `reserved`, never below `0` — a studio can lower the
            capacity under the number of existing reservations.
  responses:
    BadRequest:
      description: >-
        The request is malformed — a required parameter is missing, the
        `Authorization` header does not use the Bearer scheme, or body
        validation failed.
      headers:
        X-RateLimit-Limit:
          description: Maximum requests allowed in the current one-minute window.
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
            example: 99
        X-RateLimit-Reset:
          description: Unix timestamp in seconds when the current window resets.
          schema:
            type: integer
            example: 1788336000
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 400
            error: Error
            message: 'dateFrom parameter is required (format: YYYY-MM-DD)'
    Unauthorized:
      description: No API key was sent.
      headers:
        X-RateLimit-Limit:
          description: Maximum requests allowed in the current one-minute window.
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
            example: 99
        X-RateLimit-Reset:
          description: Unix timestamp in seconds when the current window resets.
          schema:
            type: integer
            example: 1788336000
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 401
            error: Error
            message: >-
              Missing access token. You must send your access token in the
              request header ('Authorization: Bearer YOUR_ACCESS_TOKEN' )
    Forbidden:
      description: >-
        Your studio's plan does not allow the public API. See [Plans and
        access](/api#plans-and-access).
      headers:
        X-RateLimit-Limit:
          description: Maximum requests allowed in the current one-minute window.
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
            example: 99
        X-RateLimit-Reset:
          description: Unix timestamp in seconds when the current window resets.
          schema:
            type: integer
            example: 1788336000
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 403
            error: Error
            message: The Zenamu public API is not available on the Free tariff.
    KeyNotFound:
      description: >-
        The API key was not recognized. Zenamu answers an unknown key with
        `404`, not `401` — see
        [Authentication](/api/authentication#authentication-errors).
      headers:
        X-RateLimit-Limit:
          description: Maximum requests allowed in the current one-minute window.
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
            example: 99
        X-RateLimit-Reset:
          description: Unix timestamp in seconds when the current window resets.
          schema:
            type: integer
            example: 1788336000
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 404
            error: Error
            message: API key not found
    TooManyRequests:
      description: >-
        You exceeded 100 calls per minute on this endpoint. See [Rate
        limits](/api/rate-limits).
      headers:
        X-RateLimit-Limit:
          description: Maximum requests allowed in the current one-minute window.
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
            example: 99
        X-RateLimit-Reset:
          description: Unix timestamp in seconds when the current window resets.
          schema:
            type: integer
            example: 1788336000
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 429
            error: Too Many Requests
            message: 'Rate limit exceeded: up to 100 requests per minute per endpoint.'
    InternalServerError:
      description: >-
        Unexpected server error. Retry with backoff if the call is safe to
        repeat.
      headers:
        X-RateLimit-Limit:
          description: Maximum requests allowed in the current one-minute window.
          schema:
            type: integer
            example: 100
        X-RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            minimum: 0
            example: 99
        X-RateLimit-Reset:
          description: Unix timestamp in seconds when the current window resets.
          schema:
            type: integer
            example: 1788336000
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 500
            error: Internal Server Error
            message: >-
              We apologize, but there was an error on our end. If problems
              persist, please contact us at support@zenamu.com
  securitySchemes:
    zenamuPublicKey:
      type: http
      scheme: bearer
      description: >-
        Your **public API key** (`zen_pub_…`), sent as `Authorization: Bearer
        <key>`. Browser-safe. See [Authentication](/api/authentication).

````