Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Target Type Lookup Relationships API

3 actions 3 updates phrasing extends openapi/zendesk-lookup-relationships-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Zendesk's API. It is a proposal applied on top of the contract, not a document Zendesk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/v2/{target_type}/{target_id}/relationship_fields/{field_id}/{source_type}'].get

$.paths['/api/v2/relationships/definitions/{target_type}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Target Type Lookup Relationships API
  version: 1.0.0
extends: openapi/zendesk-lookup-relationships-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/api/v2/{target_type}/{target_id}/relationship_fields/{field_id}/{source_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find records that point at an object via a lookup field
      effect: read
      questions:
      - Which tickets name this user as their Success Manager in a lookup field?
      - Can I find every record whose lookup relationship field references a given object?
      instructions:
      - text: List the {source_type} records whose lookup field {field_id} points at {target_type} {target_id}.
        slots:
          source_type: path.source_type
          field_id: path.field_id
          target_type: path.target_type
          target_id: path.target_id
      - text: Find tickets ({source_type}) where field {field_id} references {target_type} {target_id}.
        slots:
          source_type: path.source_type
          field_id: path.field_id
          target_type: path.target_type
          target_id: path.target_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/relationships/definitions/{target_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lookup relationship filter definitions
      effect: read
      questions:
      - What filter options can I use when building a lookup field's relationship filter?
      - Can I see filter definitions for a target type from a particular source type?
      instructions:
      - text: Show relationship filter definitions for target type {target_type}.
        slots:
          target_type: path.target_type
      - text: Get filter definitions for {target_type} targets from {source_type} sources.
        slots:
          target_type: path.target_type
          source_type: query.source_type
      method: generated
      generated: '2026-09-26'