{
  "info": {
    "_postman_id": "54cd6bf4-dd8d-4b82-9729-45f986ddfb00",
    "name": "JSM CS API",
    "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
  },
  "item": [
    {
      "name": "Organization",
      "description": "This resource represents organizations, including their entitlements and organization detail fields.",
      "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](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-api-v1-organization-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. You can get entitlements for an organization using the [get organization entitlements](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-api-v1-organization-organizationid-entitlement-get) API.\n**Permissions required:** Jira Service Management agent.\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": "Customer",
      "description": "This resource represents customers, including their entitlements and customer detail fields.",
      "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](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-customer/#api-api-v1-customer-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. You can get entitlements for a customer using the [get customer entitlements](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-customer/#api-api-v1-customer-customerid-entitlement-get) API.\n**Permissions required:** Jira Service Management agent.\n"
          },
          "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": "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 details and detail fields.",
      "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](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-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](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-customer/#api-api-v1-customer-customerid-get) API, \nand get entitlements for an organization using the [get organization entitlements](https://developer.stg.internal.atlassian.com/cloud/customer-service-management/rest/v1/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": []
        }
      ]
    }
  ],
  "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/"
    }
  ]
}