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

# List available tenants

> No additional permission.

All successful responses include `X-Request-Id` and `Cache-Control: private, no-store`. Requests are limited to 120 per minute.



## OpenAPI

````yaml /openapi.json get /tenants
openapi: 3.1.0
info:
  title: Gift Voucher Brilliance External API
  version: 1.0.0
  description: >-
    Read-only synchronisation and controlled voucher redemption for approved
    integrations. All operations require a bearer token. The API is limited to
    120 requests per minute per token/IP combination.
  contact:
    name: Gift Voucher Brilliance Support
    url: https://docs.giftvoucherbrilliance.co.uk/support
servers:
  - url: https://app.giftvoucherbrilliance.co.uk/api/external/v1
    description: Production
  - url: https://app.gvb-staging.co.uk/api/external/v1
    description: Staging
  - url: https://app.gvb.test/api/external/v1
    description: Local
security:
  - bearerAuth: []
tags:
  - name: Tenants
    description: Discover tenants available to the token.
  - name: Catalog
    description: Synchronise voucher products and categories.
  - name: Sales
    description: Synchronise purchased vouchers and balances.
  - name: Customers
    description: Export customers who opted in to marketing.
  - name: Redemptions
    description: Resolve, validate, and redeem vouchers.
paths:
  /tenants:
    get:
      tags:
        - Tenants
      summary: List available tenants
      description: >-
        No additional permission.


        All successful responses include `X-Request-Id` and `Cache-Control:
        private, no-store`. Requests are limited to 120 per minute.
      operationId: listTenants
      parameters:
        - name: updated_since
          in: query
          description: Return records updated at or after this ISO-8601 timestamp.
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: cursor
          in: query
          description: >-
            Opaque cursor from `next_cursor`; do not inspect or modify it. Page
            size is fixed at 50.
          schema:
            type:
              - string
              - 'null'
        - name: Accept
          in: header
          required: true
          description: Must be `application/json`.
          schema:
            type: string
            enum:
              - application/json
          example: application/json
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantCollection'
          headers:
            X-Request-Id:
              description: Request correlation identifier.
              schema:
                type: string
            Cache-Control:
              description: Sensitive responses are not shared or stored.
              schema:
                type: string
              example: private, no-store
        '401':
          description: Unauthenticated or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageError'
        '403':
          description: Token lacks the required tenant access or permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageError'
        '404':
          description: Resource or tenant was not found in the authorised scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '429':
          description: Rate limit exceeded. Retry after the window resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageError'
components:
  schemas:
    TenantCollection:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Tenant'
        next_cursor:
          type:
            - string
            - 'null'
        server_time:
          type: string
          format: date-time
          description: ISO-8601 timestamp.
      required:
        - data
        - next_cursor
        - server_time
      title: TenantCollection
    MessageError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      title: MessageError
    ValidationError:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - message
        - errors
      title: ValidationError
    Tenant:
      type: object
      properties:
        tenant_id:
          type: integer
        name:
          type: string
        subdomain:
          type: string
        parent_id:
          type:
            - integer
            - 'null'
        type:
          type: string
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: ISO-8601 timestamp.
      required:
        - tenant_id
        - name
        - subdomain
        - parent_id
        - type
        - updated_at
      title: Tenant
  securitySchemes:
    bearerAuth:
      type: http
      description: Bearer token created in the GVB API Access page.
      scheme: bearer

````