# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ghost Content and Admin Admin - Members API
  version: 1.0.0
extends: openapi/ghost-org-admin-members-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: 4
- target: $.paths['/admin/members/'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter members
      effect: read
      questions:
      - How do I get a list of all my members with their labels included?
      - Can I filter members, for example only paid subscribers?
      - What's the page size when paging through my member list?
      instructions:
      - text: List members matching filter {filter}.
        slots:
          filter: query.filter
      - text: Show me page {page} of my members, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      - text: List all members and include {include} for each.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/members/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new member
      effect: write
      questions:
      - How do I add someone to my Ghost site as a member?
      - Can I create a member with a name and labels in one call?
      instructions:
      - text: Add {members} as a new member.
        slots:
          members: requestBody.members
      - text: Create a member for a new subscriber who signed up at an event.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/members/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a member by ID
      effect: read
      questions:
      - How can I look up one member's details if I have their ID?
      - What does a single member record show about a subscriber?
      instructions:
      - text: Get member {id}.
        slots:
          id: path.id
      - text: Show me the full record for member {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/members/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a member's details
      effect: write
      questions:
      - How do I change an existing member's name or email?
      - Can I add labels to a member who's already signed up?
      instructions:
      - text: Update member {id} with {members}.
        slots:
          id: path.id
          members: requestBody.members
      - text: Change the email on member {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'