Atlassian

Atlassian User Properties API

The User Properties API from Atlassian — 4 operation(s) for user properties.

Documentation GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /wiki/rest/api/user/{userId}/property List a Confluence user's property keys · Atlassian Get User Properties #

Ask an LLM

“Which properties has my app stored on a Confluence user?”

“Can I page through all property keys for one Confluence user?”

Tell an agent

List the Confluence property keys for user {userId}.

Show Confluence user {userId}'s properties, {limit} at a time.

GET /wiki/rest/api/user/{userId}/property/{key} Get a Confluence user property by key · Atlassian Get User Property #

Ask an LLM

“What value is stored in a particular Confluence user property?”

“Can I read one Confluence entity property on a user by its key?”

Tell an agent

Get Confluence user {userId}'s property {key}.

Read property {key} stored on Confluence user {userId}.

PUT /wiki/rest/api/user/{userId}/property/{key} Update a Confluence user property's value · Atlassian Update User Property #

Ask an LLM

“Can I change the value of an existing Confluence user property?”

“Is it possible to rename a Confluence user property key, or only change its value?”

Tell an agent

Update Confluence user {userId}'s property {key} to {value}.

Change the value of property {key} on Confluence user {userId} to {value}.

POST /wiki/rest/api/user/{userId}/property/{key} Create a Confluence user property · Atlassian Create User Property By Key #

Ask an LLM

“How do I store custom data on a Confluence user?”

“Can my app create a new property on a Confluence user account?”

Tell an agent

Create property {key} with value {value} on Confluence user {userId}.

Add a new Confluence user property {key} for {userId}.

DELETE /wiki/rest/api/user/{userId}/property/{key} Delete a Confluence user property · Atlassian Delete User Property #

Ask an LLM

“Can I remove a property from a Confluence user?”

“What's the way to clear custom data stored on a Confluence user?”

Tell an agent destructive · confirm first

Delete property {key} from Confluence user {userId}.

Remove Confluence user {userId}'s {key} property.

GET /rest/api/3/user/properties List a Jira user's property keys · Atlassian Get User Property Keys #

Ask an LLM

“Which custom properties are stored against a Jira user?”

“Can I list all property keys on a Jira user account?”

Tell an agent

List the Jira user property keys for account {accountId}.

Show the property keys stored on Jira user {accountId}.

DELETE /rest/api/3/user/properties/{propertyKey} Delete a Jira user property · Atlassian Delete User Property #

Ask an LLM

“Can I remove a custom property from a Jira user?”

“Will deleting a Jira user property affect the properties Jira itself maintains?”

Tell an agent destructive · confirm first

Delete Jira user property {propertyKey} from account {accountId}.

Remove property {propertyKey} on Jira user {accountId}.

GET /rest/api/3/user/properties/{propertyKey} Get a Jira user property's value · Atlassian Get User Property #

Ask an LLM

“What value does a specific property hold on a Jira user?”

“Can I read custom data my app saved on a Jira user?”

Tell an agent

Get Jira user property {propertyKey} for account {accountId}.

Read property {propertyKey} on Jira user {accountId}.

PUT /rest/api/3/user/properties/{propertyKey} Set a Jira user property · Atlassian Set User Property #

Ask an LLM

“How do I store custom data against a Jira user?”

“Can I create or overwrite a property on a Jira user account?”

Tell an agent

Set Jira user property {propertyKey} for account {accountId}.

Save property {propertyKey} on Jira user {accountId}.

Documentation

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-webhooks/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-snippets/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/

https://developer.atlassian.com/cloud/bitbucket/rest/api-group-users/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit/

https://developer.atlassian.com/cloud/confluence/connect-modules/

https://developer.atlassian.com/cloud/confluence/rest/v2/intro/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space/

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template/

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-openapi

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/

https://developer.atlassian.com/server/framework/atlassian-sdk/audit/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/

https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/

https://developer.atlassian.com/cloud/jira/platform/connect-api-migration/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards/

https://developer.atlassian.com/cloud/jira/platform/data-security-policy-developer-guide/

https://developer.atlassian.com/platform/forge/events-reference/jira/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters/

https://developer.atlassian.com/cloud/jira/platform/forge/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-types/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/

https://developer.atlassian.com/platform/marketplace/license-api-for-cloud-apps/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-priorities/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-roles/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screens/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications--apps-/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-avatars/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions/

https://developer.atlassian.com/server/jira/platform/webhooks/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/

https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-schemes/

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs/

https://developer.atlassian.com/cloud/admin/organization/rest/

https://developer.atlassian.com/cloud/admin/user-management/rest/

https://developer.atlassian.com/cloud/admin/user-provisioning/rest/

Specifications

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-user-properties-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-hook-events-paginated_hook_events-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-pull-requests-a_pullrequest_comment_task-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-repositories-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-snippets-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-teams-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-user-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-bitbucket-workspaces-account-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-body-async-content-body-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-content-states-async-id-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-group-group-array-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-inline-tasks-task-page-response-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-longtask-long-task-status-with-links-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-search-search-page-response-search-result-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-space-content-state-settings-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-template-blueprint-template-array-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-confluence-user-account-id-email-record-schema.json

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-schema/atlassian-admin-domain-page-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-hook-events-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-pull-requests-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-repositories-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-snippets-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-teams-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-bitbucket-workspaces-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-audit-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-body-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-content-states-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-group-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-inline-tasks-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-longtask-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-relation-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-search-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-settings-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-space-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-template-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-confluence-user-context.jsonld

https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/json-ld/atlassian-admin-context.jsonld

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/atlassian:atlassian-user-properties-api"

All apis

curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Atlassian User Properties API
  version: '1.0'
  description: 'Operations tagged User Properties across 2 of this provider''s published API definitions: confluence-openapi-original.yml, jira-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: //your-domain.atlassian.net
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-user-properties-api-openapi.yml