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

# Review all structural and recipe uses of a shared record



## OpenAPI

````yaml /generated/catalog-workspace.openapi.json get /api/v1/catalog/workspace/entities/{canonicalId}/usage
openapi: 3.0.3
info:
  title: Staff Menu Manager authoring
  version: 1.0.0
  description: >-
    Persistent tenant-scoped library/relationship authoring and scoped
    publication review. Prices and POS structure retain their existing
    authority. Food Unknown is null; a nullable override inherits while []
    disables inherited rules. Publication and menu-aware public serving activate
    together through S1.
servers: []
security: []
paths:
  /api/v1/catalog/workspace/entities/{canonicalId}/usage:
    get:
      summary: Review all structural and recipe uses of a shared record
      operationId: catalogEntityUsage
      parameters:
        - name: canonicalId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Committed authoring evidence or read-only review; no publication is
            activated by a review.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogEntityUsage'
        '400':
          description: Invalid shape, units or identifier.
        '401':
          description: >-
            A current merchant staff session is required. Machine credentials
            are not admitted.
        '403':
          description: >-
            Current organization role/location grant or POS authority forbids
            the operation.
        '404':
          description: The record or location does not exist in the authorized tenant.
        '409':
          description: >-
            CATALOG_DRAFT_STALE_REVISION: refresh the current draft before
            retrying.
        '422':
          description: >-
            Invalid references, non-ready publication evidence or semantic
            validation blockers.
      security:
        - StaffSession: []
components:
  schemas:
    CatalogEntityUsage:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        draftRevision:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        directParents:
          type: array
          items:
            type: object
            properties:
              entityId:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              kind:
                type: string
                enum:
                  - menu
                  - category
                  - product
                  - modifier_group
                  - modifier_option
              name:
                type: string
            required:
              - entityId
              - kind
              - name
            additionalProperties: false
        menuIds:
          type: array
          items:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        targets:
          type: array
          items:
            type: object
            properties:
              menuId:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              locationId:
                type: string
                format: uuid
                pattern: >-
                  ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              channel:
                type: string
                enum:
                  - online
                  - catering
            required:
              - menuId
              - locationId
              - channel
            additionalProperties: false
      required:
        - entityId
        - draftRevision
        - directParents
        - menuIds
        - targets
      additionalProperties: false
  securitySchemes:
    StaffSession:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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