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

# Get Guest Consent

> The consent of one guest of a restaurant, and whether marketing can reach the guest now

Guide: [Consent, unsubscribe and preferences](https://docs.minimo.it/embedded/consent.md). Errors: [Errors and limits](https://docs.minimo.it/embedded/errors.md).


## OpenAPI

````yaml get /public/v1/tenants/{tenant}/subscriptions
openapi: 3.1.0
info:
  title: API Documentation
  description: Documentation for transactional and subscribe APIs
  version: 1.0.0
servers:
  - url: https://app.minimo.it
security:
  - bearerAuth: []
paths:
  /public/v1/tenants/{tenant}/subscriptions:
    servers:
      - url: https://api.minimo.it
    get:
      summary: Get guest consent
      description: >-
        The consent of one guest of this restaurant, and whether a marketing
        email can reach the guest now. Send `email` or `contactId`.
      operationId: getGuestConsent
      parameters:
        - name: tenant
          in: path
          required: true
          description: >-
            Your reference for the customer (for example the restaurant id). 1
            to 64 letters, digits, `.` `_` `:` `-`.
          schema:
            type: string
            example: restaurant_4812
        - name: email
          in: query
          required: false
          description: The guest.
          schema:
            type: string
        - name: contactId
          in: query
          required: false
          description: Or the guest id.
          schema:
            type: integer
      responses:
        '200':
          description: The consent
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TenantSubscription'
              example:
                data:
                  tenant: restaurant_4812
                  contactId: 4521
                  email: anna@example.com
                  status: subscribed
                  source: booking
                  subscribedAt: '2026-11-08T18:30:00.000Z'
                  unsubscribedAt: null
                  evidence:
                    ref: booking:9921
                    consentedAt: '2026-11-08T19:30:00+01:00'
                  canReceiveMarketing: true
        '401':
          description: >-
            `INVALID_TOKEN`: missing or wrong key, or a key without the
            **Widgets** or **Events** permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No such guest for this restaurant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: |-
            curl --request GET \
              --url 'https://api.minimo.it/public/v1/tenants/restaurant_4812/subscriptions?email=anna@example.com' \
              --header 'Authorization: Bearer YOUR_MINIMO_KEY'
        - lang: JavaScript
          source: >-
            const res = await
            fetch('https://api.minimo.it/public/v1/tenants/restaurant_4812/subscriptions?email=anna@example.com',
            {
              method: 'GET',
              headers: {
                Authorization: 'Bearer YOUR_MINIMO_KEY',
              },
            });

            const { data } = await res.json();

            console.log(data);
        - lang: Python
          source: |-
            import requests

            res = requests.get(
                'https://api.minimo.it/public/v1/tenants/restaurant_4812/subscriptions?email=anna@example.com',
                headers={'Authorization': 'Bearer YOUR_MINIMO_KEY'},
            )
            print(res.status_code, res.text)
components:
  schemas:
    TenantSubscription:
      type: object
      properties:
        tenant:
          type: string
          example: restaurant_4812
        contactId:
          type: integer
          example: 4521
        email:
          type: string
          nullable: true
          example: anna@example.com
        status:
          type: string
          enum:
            - subscribed
            - unsubscribed
            - none
        source:
          type: string
          nullable: true
          example: booking
        subscribedAt:
          type: string
          format: date-time
          nullable: true
        unsubscribedAt:
          type: string
          format: date-time
          nullable: true
        evidence:
          type: object
          nullable: true
          description: The evidence stored with the consent.
        canReceiveMarketing:
          type: boolean
          description: >-
            Whether a marketing email of this restaurant can reach the guest
            now.
      required:
        - tenant
        - contactId
        - email
        - status
        - canReceiveMarketing
    ApiError:
      type: object
      properties:
        status:
          type: string
          example: FAIL
        message:
          type: string
          description: The error code to test in your code.
          example: INVALID_PARAMETERS
        userMessage:
          type: string
          description: >-
            When present, a sentence that says what to fix. You can show or log
            it.
          example: Set the origins allowed to embed the widgets first.
      description: >-
        Every error has this shape. See [Errors and limits](/embedded/errors)
        for every code.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: mn-API_CLIENT_ID-API_KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.