> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# jira-servicedesk-customers

> Service desk customers

**Server path:** `/jira-servicedesk-customers` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                              | Description                        |
| --------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| [`jira-servicedesk-customers_add_customers`](#jira-servicedesk-customers_add_customers)                                           | Add customers                      |
| [`jira-servicedesk-customers_add_organization`](#jira-servicedesk-customers_add_organization)                                     | Add organization                   |
| [`jira-servicedesk-customers_add_users_to_organization`](#jira-servicedesk-customers_add_users_to_organization)                   | Add users to organization          |
| [`jira-servicedesk-customers_create_customer`](#jira-servicedesk-customers_create_customer)                                       | Create customer                    |
| [`jira-servicedesk-customers_create_organization`](#jira-servicedesk-customers_create_organization)                               | Create organization                |
| [`jira-servicedesk-customers_delete_organization`](#jira-servicedesk-customers_delete_organization)                               | Delete organization                |
| [`jira-servicedesk-customers_get_customers`](#jira-servicedesk-customers_get_customers)                                           | Get customers                      |
| [`jira-servicedesk-customers_get_organization`](#jira-servicedesk-customers_get_organization)                                     | Get organization                   |
| [`jira-servicedesk-customers_get_organizations`](#jira-servicedesk-customers_get_organizations)                                   | Get organizations                  |
| [`jira-servicedesk-customers_get_service_desk_organizations`](#jira-servicedesk-customers_get_service_desk_organizations)         | Get organizations                  |
| [`jira-servicedesk-customers_get_users_in_organization`](#jira-servicedesk-customers_get_users_in_organization)                   | Get users in organization          |
| [`jira-servicedesk-customers_invite_customer`](#jira-servicedesk-customers_invite_customer)                                       | Invite customer                    |
| [`jira-servicedesk-customers_remove_customers`](#jira-servicedesk-customers_remove_customers)                                     | Remove customers                   |
| [`jira-servicedesk-customers_remove_organization`](#jira-servicedesk-customers_remove_organization)                               | Remove organization                |
| [`jira-servicedesk-customers_remove_users_from_organization`](#jira-servicedesk-customers_remove_users_from_organization)         | Remove users from organization     |
| [`jira-servicedesk-customers_revoke_portal_only_access_for_user`](#jira-servicedesk-customers_revoke_portal_only_access_for_user) | Revoke portal only access for user |

***

## jira-servicedesk-customers\_add\_customers

Add customers

**Parameters:**

| Parameter       | Type      | Required | Default | Description                                                                                                                                                                                                                                                         |
| --------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `serviceDeskId` | string    | Yes      | —       | The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.                                                                                                                                               |
| `accountIds`    | string\[] | No       | —       | List of users, specified by account IDs, to add to or remove from a service desk.                                                                                                                                                                                   |
| `usernames`     | string\[] | No       | —       | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers)"
      },
      "accountIds": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of users, specified by account IDs, to add to or remove from a service desk."
      },
      "usernames": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_add\_organization

Add organization

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                                                         |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| `serviceDeskId`  | string  | Yes      | —       | The ID of the service desk to which the organization will be added. This can alternatively be a project identifier. |
| `organizationId` | integer | Yes      | —       | List of organizations, specified by 'ID' field values, to add to or remove from the service desk.                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk to which the organization will be added. This can alternatively be a [project identifier.](#project-identifiers)"
      },
      "organizationId": {
        "type": "integer",
        "description": "List of organizations, specified by 'ID' field values, to add to or remove from the service desk."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_add\_users\_to\_organization

Add users to organization

**Parameters:**

| Parameter        | Type      | Required | Default | Description                                                                                                                                                                                                                                                         |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organizationId` | integer   | Yes      | —       | The ID of the organization.                                                                                                                                                                                                                                         |
| `accountIds`     | string\[] | No       | —       | List of customers, specific by account IDs, to add to or remove from the organization.                                                                                                                                                                              |
| `usernames`      | string\[] | No       | —       | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "organizationId": {
        "type": "integer",
        "description": "The ID of the organization."
      },
      "accountIds": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of customers, specific by account IDs, to add to or remove from the organization."
      },
      "usernames": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
      }
    },
    "required": [
      "PCID",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_create\_customer

Create customer

**Parameters:**

| Parameter                  | Type    | Required | Default | Description                                                                                      |
| -------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `strictConflictStatusCode` | boolean | No       | —       | Optional boolean flag to return 409 Conflict status code for duplicate customer creation request |
| `displayName`              | string  | Yes      | —       | Customer's name for display in the UI.                                                           |
| `email`                    | string  | Yes      | —       | Customer's email address.                                                                        |
| `fullName`                 | string  | No       | —       | Deprecated, please use 'displayName'.                                                            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "strictConflictStatusCode": {
        "type": "boolean",
        "description": "Optional boolean flag to return 409 Conflict status code for duplicate customer creation request"
      },
      "displayName": {
        "type": "string",
        "description": "Customer's name for display in the UI."
      },
      "email": {
        "type": "string",
        "description": "Customer's email address."
      },
      "fullName": {
        "type": "string",
        "description": "Deprecated, please use 'displayName'."
      }
    },
    "required": [
      "PCID",
      "displayName",
      "email"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_create\_organization

Create organization

**Parameters:**

| Parameter | Type   | Required | Default | Description                                              |
| --------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `name`    | string | Yes      | —       | Name of the organization. Must contain 1-200 characters. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Name of the organization. Must contain 1-200 characters."
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_delete\_organization

Delete organization

**Parameters:**

| Parameter        | Type    | Required | Default | Description                 |
| ---------------- | ------- | -------- | ------- | --------------------------- |
| `organizationId` | integer | Yes      | —       | The ID of the organization. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "organizationId": {
        "type": "integer",
        "description": "The ID of the organization."
      }
    },
    "required": [
      "PCID",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_get\_customers

Get customers

**Parameters:**

| Parameter       | Type    | Required | Default | Description                                                                                                           |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
| `serviceDeskId` | string  | Yes      | —       | The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier. |
| `query`         | string  | No       | —       | The string used to filter the customer list.                                                                          |
| `start`         | integer | No       | —       | The starting index of the returned objects. Base index: 0. See the Pagination section for more details.               |
| `limit`         | integer | No       | —       | The maximum number of users to return per page. Default: 50. See the Pagination section for more details.             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers)"
      },
      "query": {
        "type": "string",
        "description": "The string used to filter the customer list."
      },
      "start": {
        "type": "integer",
        "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
      },
      "limit": {
        "type": "integer",
        "description": "The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_get\_organization

Get organization

**Parameters:**

| Parameter        | Type    | Required | Default | Description                 |
| ---------------- | ------- | -------- | ------- | --------------------------- |
| `organizationId` | integer | Yes      | —       | The ID of the organization. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "organizationId": {
        "type": "integer",
        "description": "The ID of the organization."
      }
    },
    "required": [
      "PCID",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_get\_organizations

Get organizations

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                                                                                            |
| ----------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `start`     | integer | No       | —       | The starting index of the returned objects. Base index: 0. See the Pagination section for more details.                                |
| `limit`     | integer | No       | —       | The maximum number of organizations to return per page. Default: 50. See the Pagination section for more details.                      |
| `accountId` | string  | No       | —       | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "start": {
        "type": "integer",
        "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
      },
      "limit": {
        "type": "integer",
        "description": "The maximum number of organizations to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
      },
      "accountId": {
        "type": "string",
        "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_get\_service\_desk\_organizations

Get organizations

**Parameters:**

| Parameter       | Type    | Required | Default | Description                                                                                                                            |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `serviceDeskId` | string  | Yes      | —       | The ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier.          |
| `start`         | integer | No       | —       | The starting index of the returned objects. Base index: 0. See the Pagination section for more details.                                |
| `limit`         | integer | No       | —       | The maximum number of items to return per page. Default: 50. See the Pagination section for more details.                              |
| `accountId`     | string  | No       | —       | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk from which the organization list will be returned. This can alternatively be a [project identifier.](#project-identifiers)"
      },
      "start": {
        "type": "integer",
        "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
      },
      "limit": {
        "type": "integer",
        "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
      },
      "accountId": {
        "type": "string",
        "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_get\_users\_in\_organization

Get users in organization

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                                               |
| ---------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `organizationId` | integer | Yes      | —       | The ID of the organization.                                                                               |
| `start`          | integer | No       | —       | The starting index of the returned objects. Base index: 0. See the Pagination section for more details.   |
| `limit`          | integer | No       | —       | The maximum number of users to return per page. Default: 50. See the Pagination section for more details. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "organizationId": {
        "type": "integer",
        "description": "The ID of the organization."
      },
      "start": {
        "type": "integer",
        "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
      },
      "limit": {
        "type": "integer",
        "description": "The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
      }
    },
    "required": [
      "PCID",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_invite\_customer

Invite customer

**Parameters:**

| Parameter                  | Type    | Required | Default | Description                                                                                                  |
| -------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `serviceDeskId`            | string  | Yes      | —       | The ID of the service desk to which the newly created customer should be added.                              |
| `strictConflictStatusCode` | boolean | No       | —       | Optional boolean flag to return 409 Conflict status code when a customer with the same email already exists. |
| `displayName`              | string  | No       | —       | Customer's name for display in the UI.                                                                       |
| `email`                    | string  | Yes      | —       | Customer's email address.                                                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk to which the newly created customer should be added."
      },
      "strictConflictStatusCode": {
        "type": "boolean",
        "description": "Optional boolean flag to return 409 Conflict status code when a customer with the same email already exists."
      },
      "displayName": {
        "type": "string",
        "description": "Customer's name for display in the UI."
      },
      "email": {
        "type": "string",
        "description": "Customer's email address."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId",
      "email"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_remove\_customers

Remove customers

**Parameters:**

| Parameter       | Type      | Required | Default | Description                                                                                                                                                                                                                                                         |
| --------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `serviceDeskId` | string    | Yes      | —       | The ID of the service desk the customers should be removed from. This can alternatively be a project identifier.                                                                                                                                                    |
| `accountIds`    | string\[] | No       | —       | List of users, specified by account IDs, to add to or remove from a service desk.                                                                                                                                                                                   |
| `usernames`     | string\[] | No       | —       | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk the customers should be removed from. This can alternatively be a [project identifier.](#project-identifiers)"
      },
      "accountIds": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of users, specified by account IDs, to add to or remove from a service desk."
      },
      "usernames": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_remove\_organization

Remove organization

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                                                             |
| ---------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `serviceDeskId`  | string  | Yes      | —       | The ID of the service desk from which the organization will be removed. This can alternatively be a project identifier. |
| `organizationId` | integer | Yes      | —       | List of organizations, specified by 'ID' field values, to add to or remove from the service desk.                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serviceDeskId": {
        "type": "string",
        "description": "The ID of the service desk from which the organization will be removed. This can alternatively be a [project identifier.](#project-identifiers)"
      },
      "organizationId": {
        "type": "integer",
        "description": "List of organizations, specified by 'ID' field values, to add to or remove from the service desk."
      }
    },
    "required": [
      "PCID",
      "serviceDeskId",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_remove\_users\_from\_organization

Remove users from organization

**Parameters:**

| Parameter        | Type      | Required | Default | Description                                                                                                                                                                                                                                                         |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organizationId` | integer   | Yes      | —       | The ID of the organization.                                                                                                                                                                                                                                         |
| `accountIds`     | string\[] | No       | —       | List of customers, specific by account IDs, to add to or remove from the organization.                                                                                                                                                                              |
| `usernames`      | string\[] | No       | —       | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "organizationId": {
        "type": "integer",
        "description": "The ID of the organization."
      },
      "accountIds": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of customers, specific by account IDs, to add to or remove from the organization."
      },
      "usernames": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
      }
    },
    "required": [
      "PCID",
      "organizationId"
    ]
  }
  ```
</Expandable>

***

## jira-servicedesk-customers\_revoke\_portal\_only\_access\_for\_user

Revoke portal only access for user

**Parameters:**

| Parameter   | Type   | Required | Default | Description                                                                                                                                                    |
| ----------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId` | string | Yes      | —       | The account ID of the user, which uniquely identifies the portal-only account. For example, *qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b*. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "accountId": {
        "type": "string",
        "description": "The account ID of the user, which uniquely identifies the portal-only account. For example, *qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b*."
      }
    },
    "required": [
      "PCID",
      "accountId"
    ]
  }
  ```
</Expandable>