Clickup · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clickup Guests API

11 actions 11 updates phrasing extends openapi/clickup-guests-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clickup's API. It is a proposal applied on top of the contract, not a document Clickup publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/v2/team/{team_id}/guest'].post
$.paths['/v2/team/{team_id}/guest/{guest_id}'].get
$.paths['/v2/team/{team_id}/guest/{guest_id}'].put
$.paths['/v2/team/{team_id}/guest/{guest_id}'].delete
$.paths['/v2/task/{task_id}/guest/{guest_id}'].post
$.paths['/v2/task/{task_id}/guest/{guest_id}'].delete
$.paths['/v2/list/{list_id}/guest/{guest_id}'].post
$.paths['/v2/list/{list_id}/guest/{guest_id}'].delete
$.paths['/v2/folder/{folder_id}/guest/{guest_id}'].post
$.paths['/v2/folder/{folder_id}/guest/{guest_id}'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clickup Guests API
  version: 1.0.0
extends: openapi/clickup-guests-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: 10
- target: $.paths['/v2/team/{team_id}/guest'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a guest to a Workspace
      effect: write
      questions:
      - How do I invite an outside contractor into my ClickUp Workspace as a guest?
      - Can I stop a guest from seeing time spent or creating views when I invite them?
      instructions:
      - text: Invite {email} as a guest to Workspace {team_id}.
        slots:
          email: requestBody.email
          team_id: path.team_id
      - text: Invite guest {email} to {team_id} with custom role {custom_role_id} and tag editing set to {can_edit_tags}.
        slots:
          email: requestBody.email
          team_id: path.team_id
          custom_role_id: requestBody.custom_role_id
          can_edit_tags: requestBody.can_edit_tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/team/{team_id}/guest/{guest_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a guest
      effect: read
      questions:
      - What permissions does a particular guest have in my Workspace?
      - Is guest lookup limited to the Enterprise Plan?
      instructions:
      - text: Show guest {guest_id} in Workspace {team_id}.
        slots:
          guest_id: path.guest_id
          team_id: path.team_id
      - text: Get the details for guest {guest_id} of {team_id}.
        slots:
          guest_id: path.guest_id
          team_id: path.team_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/team/{team_id}/guest/{guest_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a guest's permissions
      effect: write
      questions:
      - Can I let an existing guest see time estimates without making them a member?
      - Is it possible to change a guest's custom role after they've joined?
      instructions:
      - text: 'Let guest {guest_id} in {team_id} see time spent: {can_see_time_spent}.'
        slots:
          guest_id: path.guest_id
          team_id: path.team_id
          can_see_time_spent: requestBody.can_see_time_spent
      - text: Switch guest {guest_id} in Workspace {team_id} to custom role {custom_role_id}.
        slots:
          guest_id: path.guest_id
          team_id: path.team_id
          custom_role_id: requestBody.custom_role_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/team/{team_id}/guest/{guest_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a guest's Workspace access
      effect: destructive
      questions:
      - How do I kick a guest out of my Workspace entirely?
      - Can I revoke all of a contractor's guest access in one step?
      instructions:
      - text: Remove guest {guest_id} from Workspace {team_id}.
        slots:
          guest_id: path.guest_id
          team_id: path.team_id
      - text: Revoke all Workspace access for guest {guest_id} in {team_id}.
        slots:
          guest_id: path.guest_id
          team_id: path.team_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/task/{task_id}/guest/{guest_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a task with a guest
      effect: write
      questions:
      - Can I share a single task with a guest and choose whether they can edit it?
      - What permission levels can a guest get on a task?
      instructions:
      - text: Share task {task_id} with guest {guest_id} at permission level {permission_level}.
        slots:
          task_id: path.task_id
          guest_id: path.guest_id
          permission_level: requestBody.permission_level
      - text: Give guest {guest_id} read access to task {task_id}.
        slots:
          guest_id: path.guest_id
          task_id: path.task_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/task/{task_id}/guest/{guest_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unshare a task from a guest
      effect: destructive
      questions:
      - How do I take away a guest's access to one task?
      - Can I revoke a task share using a custom task ID?
      instructions:
      - text: Revoke guest {guest_id}'s access to task {task_id}.
        slots:
          guest_id: path.guest_id
          task_id: path.task_id
      - text: Stop sharing task {task_id} with guest {guest_id}.
        slots:
          task_id: path.task_id
          guest_id: path.guest_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/list/{list_id}/guest/{guest_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a List with a guest
      effect: write
      questions:
      - Can a guest be given access to a whole List at once?
      - Which permission level should I pick when sharing a List with a client?
      instructions:
      - text: Share List {list_id} with guest {guest_id} at permission level {permission_level}.
        slots:
          list_id: path.list_id
          guest_id: path.guest_id
          permission_level: requestBody.permission_level
      - text: Give guest {guest_id} edit rights on List {list_id}.
        slots:
          guest_id: path.guest_id
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/list/{list_id}/guest/{guest_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unshare a List from a guest
      effect: destructive
      questions:
      - How do I remove a guest from a List they were shared on?
      - Does revoking List access leave the guest in the Workspace?
      instructions:
      - text: Revoke guest {guest_id}'s access to List {list_id}.
        slots:
          guest_id: path.guest_id
          list_id: path.list_id
      - text: Stop sharing List {list_id} with guest {guest_id}.
        slots:
          list_id: path.list_id
          guest_id: path.guest_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/folder/{folder_id}/guest/{guest_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a Folder with a guest
      effect: write
      questions:
      - Can I share an entire Folder with a guest?
      - What access levels are available when a guest is added to a Folder?
      instructions:
      - text: Share Folder {folder_id} with guest {guest_id} at permission level {permission_level}.
        slots:
          folder_id: path.folder_id
          guest_id: path.guest_id
          permission_level: requestBody.permission_level
      - text: Give guest {guest_id} comment access to Folder {folder_id}.
        slots:
          guest_id: path.guest_id
          folder_id: path.folder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/folder/{folder_id}/guest/{guest_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unshare a Folder from a guest
      effect: destructive
      questions:
      - How do I pull a guest's access to a Folder?
      - Is removing a guest from a Folder an Enterprise-only feature?
      instructions:
      - text: Revoke guest {guest_id}'s access to Folder {folder_id}.
        slots:
          guest_id: path.guest_id
          folder_id: path.folder_id
      - text: Stop sharing Folder {folder_id} with guest {guest_id}.
        slots:
          folder_id: path.folder_id
          guest_id: path.guest_id
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/clickup-guests-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.