Generated by API Evangelist
Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Confluence Cloud REST API v2 User API
version: 1.0.0
extends: openapi/confluence-user-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/users-bulk'].post
update:
x-apievangelist-phrasing:
intent: Look up several users by account id
effect: read
questions:
- How can I get profile details for a batch of account ids at once?
- Can I resolve many Atlassian account ids to users in one request?
instructions:
- text: Look up users with account ids {accountIds}.
slots:
accountIds: requestBody.accountIds
- text: Fetch user details for accounts {accountIds} in bulk.
slots:
accountIds: requestBody.accountIds
method: generated
generated: '2026-10-01'
- target: $.paths['/user/access/check-access-by-email'].post
update:
x-apievangelist-phrasing:
intent: Check which emails lack site access
effect: read
questions:
- Which people on my list don't have access to the Confluence site yet?
- Can I check site access for a list of email addresses?
instructions:
- text: Check which of {emails} do not have site access.
slots:
emails: requestBody.emails
- text: Tell me who among {emails} still needs access to the site.
slots:
emails: requestBody.emails
method: generated
generated: '2026-10-01'
- target: $.paths['/user/access/invite-by-email'].post
update:
x-apievangelist-phrasing:
intent: Invite people to the site by email
effect: write
questions:
- How do I invite a list of people to Confluence by email address?
- What happens if I invite someone who already has access?
instructions:
- text: Invite {emails} to the site.
slots:
emails: requestBody.emails
- text: Send site invitations to email addresses {emails}.
slots:
emails: requestBody.emails
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.