{ "info": { "_postman_id": "98602417-6e01-4e12-8bdc-ec91cce6df4f", "name": "Atlassian CSM API", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Organization", "description": "This resource represents organizations. Use this to manage an organization, profile, detail fields and values, entitlements and customers they have.", "item": [ { "name": "Get organization detail fields", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/details", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns all organization detail fields, including their configuration. You can use the [get organization profile](./#api-api-v1-organization-profile-organizationid-get) API to get details for a particular organization.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Create organization detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/details", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates an organization detail field. You can create up to 50 detail fields. \n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Edit organization detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/details/:fieldName", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Renames an organization detail field and/or changes the available options for SELECT or MULTISELECT fields.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete organization detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/details/:fieldName", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes an organization detail field and all values stored for it for all organizations. You cannot restore a detail field once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Get organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/:organizationId", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns an organization, including its details.\nIt is recommended to use the [get organization profile API](./#api-api-v1-organization-profile-organizationid-get) which is a simpler response shape to work with and also includes the entitlements for the organization.\n**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Update organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/:organizationId", "query": [], "variable": [] }, "method": "PUT", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates an organization's name.\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to update organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/:organizationId", "query": [], "variable": [] }, "method": "DELETE", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false } ], "description": "Deletes an organization. You cannot restore an organization once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Set organization detail", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/:organizationId/details", "query": [ { "key": "fieldName", "value": "{{fieldName}}", "disabled": false, "description": "The name of the organization detail field to set the value of." } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get organization entitlements", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/:organizationId/entitlement", "query": [ { "key": "product", "value": "{{product}}", "disabled": true, "description": "A product ID to optionally filter the entitlements to just entitlements of that product." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a list of the organization's entitlements, along with their details.\n**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Create organization entitlement", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/:organizationId/entitlement", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Create organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates an organization.\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Fetch multiple organizations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/fetch", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a maximum of 50 organizations, fetched by organization id or name.\nAny organizations that cannot be found will be omitted from the results.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get organization profile", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/profile/:organizationId", "query": [], "variable": [] }, "method": "GET", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a organization's profile, including its custom details and any product entitlements.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n" }, "response": [] }, { "name": "Create organization profile", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/profile", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates an organization's profile, including adding the organization's detail fields, customers belonging to the organization and any product entitlements.\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Fetch multiple organization profiles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/profile/fetch", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a maximum of 25 organization profiles.\nAny organizations that cannot be found will be omitted from the results.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Organization bulk operations", "description": "This resource represents bulk operations for organizations. Use this to perform bulk operations on organizations, including their profiles and detail fields and values.", "item": [ { "name": "Bulk manage organization profiles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/profile/bulk", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{Idempotency-Key}}", "disabled": false }, { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk manage multiple organization profiles with detail fields.\nAllows creating, updating or upserting up to 100 organization profiles in a single request.\n**Organization Identification:** To identify organizations, provide either `id` or `name`. When using UPSERT operation, note that providing only `id` (without `name`) will not create a new organization if the organization doesn't exist. The `name` field must be provided to create new organizations.\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Bulk manage organizations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/bulk", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{Idempotency-Key}}", "disabled": false }, { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk manage multiple organizations. This allows up to 50 organizations in a single request.\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to update organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Bulk manage organizations' detail field values", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/organization/details/bulk", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{Idempotency-Key}}", "disabled": false }, { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk manage organization detail field values for multiple organizations. Supports UPDATE, PATCH, and DELETE operations across multiple organizations and detail fields.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Customer", "description": "This resource represents customers. Use this to manage a customer account, profile, detail fields and values, entitlements and organizations they are a member of.", "item": [ { "name": "Get customer detail fields", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/details", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns all customer detail fields, including their configuration. You can use the [get customer profile](./#api-api-v1-customer-profile-customerid-get)\nAPI to get details for a particular customer.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Create customer detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/details", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a customer detail field. You can create up to 50 detail fields. \n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Edit customer detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/details/:fieldName", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Renames a customer detail field and/or changes the available options for SELECT or MULTISELECT fields.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete customer detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/details/:fieldName", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a customer detail field and all values stored for it for all customers. You cannot restore a detail field once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Get customer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/:customerId", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a customer, including their details.\nIt is recommended to use the [get customer profile API](./#api-api-v1-customer-profile-customerid-get) which is a simpler response shape to work with and also includes the entitlements for the customer.\n**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Search customer by detail field and value", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/search-by-detail-field", "query": [ { "key": "page", "value": "{{page}}", "disabled": true }, { "key": "maxResults", "value": "{{maxResults}}", "disabled": true } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the list of customers. You can get details and entitlements for a customer using [get customer profile](./#api-api-v1-customer-profile-customerid-get) API.\n**Permissions required:** Jira Service Management agent.\nTo retrieve restricted information such as email address of the user, **Administer Jira** [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Set customer detail", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/:customerId/details", "query": [ { "key": "fieldName", "value": "{{fieldName}}", "disabled": false, "description": "The name of the customer detail field to set the value of." } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get customer entitlements", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/:customerId/entitlement", "query": [ { "key": "product", "value": "{{product}}", "disabled": true, "description": "A product ID to optionally filter the entitlements to just entitlements of that product." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a list of the customer's entitlements, including entitlements inherited by any organizations the customer is in, along with their details.\n**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Create customer entitlement", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/:customerId/entitlement", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Create customer account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a customer account.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get customer account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/account/:customerId", "query": [], "variable": [] }, "method": "GET", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a customer's account information.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n" }, "response": [] }, { "name": "Update customer account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/account/:customerId", "query": [], "variable": [] }, "method": "PUT", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a customer account's display name.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete customer account", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/account/:customerId", "query": [], "variable": [] }, "method": "DELETE", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false } ], "description": "Deletes a customer. You cannot restore a customer account once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Get customer profile", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/profile/:customerId", "query": [], "variable": [] }, "method": "GET", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a customer's profile, including their custom details, any organizations the customer is in, and any customer entitlements.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n" }, "response": [] }, { "name": "Create customer profile", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/profile", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a customer's profile, including their custom details and associating them with the specified organizations and products.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/), and Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Fetch multiple customer profiles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/profile/fetch", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a maximum of 25 customer profiles. This includes detail fields and any organizations the customer is in.\nAny customer accounts that cannot be found will be omitted from the results.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Customer bulk operations", "description": "This resource represents bulk operations for customers. Use this to perform bulk operations on customer accounts, profiles, and detail fields and values.", "item": [ { "name": "Bulk manage customers' detail field values", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/details/bulk", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{Idempotency-Key}}", "disabled": false }, { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk manage customer detail field values for multiple customers. Supports UPDATE, PATCH, and DELETE operations across multiple customers and detail fields.\n**Permissions required:** Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Bulk manage customer accounts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/bulk", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{Idempotency-Key}}", "disabled": false }, { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk manage multiple customer accounts. This allows up to 50 customer accounts in a single request.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Bulk manage multiple customer profiles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/customer/profile/bulk", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{Idempotency-Key}}", "disabled": false }, { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk manage multiple customer profiles with detail fields and organization associations.\nAllows creating, updating or upserting up to 100 customer profiles in a single request.\n**Customer Identification:** To identify customers, provide either `email` or `customerId`. When using UPSERT operation, note that providing only `customerId` (without `email`) will not create a new customer if the customer doesn't exist. The `email` field must be provided to create new customers.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/), and Customer Service Management or Jira Service Management user.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Product", "description": "This resource represents products.", "item": [ { "name": "Get products", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/product", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The number of products to fetch. Defaults to 100 if not specified or value given is less than 1 or greater than 100." }, { "key": "cursor", "value": "{{cursor}}", "disabled": true, "description": "The starting point for the page of results to return. Use the value of `nextPageCursor` in one request to get the next page." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Create product", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/product", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get product", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/product/:productId", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Rename product", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/product/:productId", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete product", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/product/:productId", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes a product and all entitlements associated with it. You cannot restore a detail field once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] } ] }, { "name": "Entitlement", "description": "This resource represents entitlements, including their details. Use this to manage entitlement detail fields and values.", "item": [ { "name": "Get entitlement detail fields", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/details", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns all entitlement detail fields, including their configuration. You can use the [get entitlement](./#api-api-v1-entitlement-entitlementid-get)\nAPI to get details for a particular entitlement.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Create entitlement detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/details", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates an entitlement detail field. You can create up to 50 detail fields. \n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Edit entitlement detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/details/:fieldName", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Renames an entitlement detail field and/or changes the available options for SELECT or MULTISELECT fields.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete entitlement detail field", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/details/:fieldName", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes an entitlement detail field and all values stored for it for all entitlements. You cannot restore a detail field once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Get entitlement", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/:entitlementId", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns an entitlement, including its details. You can get entitlements for a customer using the [get customer entitlements](../api-group-customer/#api-api-v1-customer-customerid-get) API,\nand get entitlements for an organization using the [get organization entitlements](../api-group-organization/#api-api-v1-organization-organizationid-get) API.\n**Permissions required:** Jira Service Management agent.\n" }, "response": [] }, { "name": "Delete entitlement", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/:entitlementId", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes the specified entitlement along with its detail fields. You cannot restore an entitlement once it has been deleted.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n" }, "response": [] }, { "name": "Set entitlement detail", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/entitlement/:entitlementId/details", "query": [ { "key": "fieldName", "value": "{{fieldName}}", "disabled": false, "description": "The name of the entitlement detail field to set the value of." } ], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**Permissions required:** Jira Service Management agent.\n", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Task", "description": "This resource represents tasks. Use this to manage viewing the status of tasks.", "item": [ { "name": "Get task status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/v1/tasks/:taskId", "query": [], "variable": [] }, "method": "GET", "header": [ { "key": "X-ExperimentalApi", "value": "{{X-ExperimentalApi}}", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the status of a given task, including a list of any failures on completion.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/), or Customer Service Management or Jira Service Management user.\n" }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "jsm/csm/cloudid/%7BcloudId%7D/" } ] }