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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Clickup Users API
version: 1.0.0
extends: openapi/clickup-users-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['/v2/team/{team_id}/user'].post
update:
x-apievangelist-phrasing:
intent: Invite someone to a Workspace as a member
effect: write
questions:
- How do I invite a new member to my ClickUp Workspace by email?
- Can I make an invited member an admin or give them a custom role?
instructions:
- text: Invite {email} to Workspace {team_id} as a member, admin {admin}.
slots:
email: requestBody.email
team_id: path.team_id
admin: requestBody.admin
- text: Invite {email} to Workspace {team_id} with custom role {custom_role_id}, admin {admin}.
slots:
email: requestBody.email
team_id: path.team_id
custom_role_id: requestBody.custom_role_id
admin: requestBody.admin
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/team/{team_id}/user/{user_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a user's details in a Workspace
effect: read
questions:
- What information can I see about a user in my Workspace?
- Which plan do I need to look up a Workspace user's details?
instructions:
- text: Get user {user_id} in Workspace {team_id}.
slots:
user_id: path.user_id
team_id: path.team_id
- text: Show user {user_id} in Workspace {team_id} including items shared with them.
slots:
user_id: path.user_id
team_id: path.team_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/team/{team_id}/user/{user_id}'].put
update:
x-apievangelist-phrasing:
intent: Change a Workspace user's name and role
effect: write
questions:
- How do I change a user's name or role in my Workspace?
- Can I promote a member to admin?
instructions:
- text: 'Update user {user_id} in Workspace {team_id}: username {username}, admin {admin}, role {custom_role_id}.'
slots:
user_id: path.user_id
team_id: path.team_id
username: requestBody.username
admin: requestBody.admin
custom_role_id: requestBody.custom_role_id
- text: Give user {user_id} in Workspace {team_id} custom role {custom_role_id}.
slots:
user_id: path.user_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}/user/{user_id}'].delete
update:
x-apievangelist-phrasing:
intent: Deactivate a user from a Workspace
effect: destructive
questions:
- How do I remove someone from my Workspace?
- Does removing a user deactivate them rather than delete them?
instructions:
- text: Remove user {user_id} from Workspace {team_id}.
slots:
user_id: path.user_id
team_id: path.team_id
- text: Deactivate user {user_id} in Workspace {team_id}.
slots:
user_id: path.user_id
team_id: path.team_id
method: generated
generated: '2026-09-26'
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.