> ## 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-projects
> Jira Projects - browse projects, components, versions, statuses, categories, and dashboards
**Server path:** `/jira-projects` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------- | ------------------------------ |
| [`jira_projects_create_component`](#jira_projects_create_component) | Create component |
| [`jira_projects_create_version`](#jira_projects_create_version) | Create version |
| [`jira_projects_get_all_available_dashboard_gadgets`](#jira_projects_get_all_available_dashboard_gadgets) | Get available gadgets |
| [`jira_projects_get_all_gadgets`](#jira_projects_get_all_gadgets) | Get gadgets |
| [`jira_projects_get_all_project_categories`](#jira_projects_get_all_project_categories) | Get all project categories |
| [`jira_projects_get_all_statuses`](#jira_projects_get_all_statuses) | Get all statuses for project |
| [`jira_projects_get_component`](#jira_projects_get_component) | Get component |
| [`jira_projects_get_dashboard`](#jira_projects_get_dashboard) | Get dashboard |
| [`jira_projects_get_dashboards_paginated`](#jira_projects_get_dashboards_paginated) | Search for dashboards |
| [`jira_projects_get_project`](#jira_projects_get_project) | Get project |
| [`jira_projects_get_project_components`](#jira_projects_get_project_components) | Get project components |
| [`jira_projects_get_project_versions_paginated`](#jira_projects_get_project_versions_paginated) | Get project versions paginated |
| [`jira_projects_get_recent`](#jira_projects_get_recent) | Get recent projects |
| [`jira_projects_get_status_categories`](#jira_projects_get_status_categories) | Get all status categories |
| [`jira_projects_get_status_category`](#jira_projects_get_status_category) | Get status category |
| [`jira_projects_get_statuses`](#jira_projects_get_statuses) | Get all statuses |
| [`jira_projects_get_version`](#jira_projects_get_version) | Get version |
| [`jira_projects_search_projects`](#jira_projects_search_projects) | Get projects paginated |
***
## jira\_projects\_create\_component
Create component
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ari` | string | No | — | Compass component's ID. Can't be updated. Not required for creating a Project Component. |
| `assignee` | object | No | — | The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component. |
| `assigneeType` | string | No | — | The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: \* `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. \* `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. \* `UNASSIGNED` an assignee is not set for issues created with this component. \* `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. |
| `description` | string | No | — | The description for the component. Optional when creating or updating a component. |
| `id` | string | No | — | The unique identifier for the component. |
| `isAssigneeTypeValid` | boolean | No | — | Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned. |
| `lead` | object | No | — | The user details for the component's lead user. |
| `leadAccountId` | string | No | — | The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. |
| `leadUserName` | 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. |
| `metadata` | object | No | — | Compass component's metadata. Can't be updated. Not required for creating a Project Component. |
| `name` | string | No | — | The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters. |
| `project` | string | No | — | The key of the project the component is assigned to. Required when creating a component. Can't be updated. |
| `projectId` | integer | No | — | The ID of the project the component is assigned to. |
| `realAssignee` | object | No | — | The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. |
| `realAssigneeType` | string | No | — | The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: \* `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. \* `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. \* `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. \* `PROJECT_DEFAULT` when none of the preceding cases are true. |
| `self` | string | No | — | The URL of the component. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ari": {
"type": "string",
"description": "Compass component's ID. Can't be updated. Not required for creating a Project Component."
},
"assignee": {
"description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component."
},
"assigneeType": {
"type": "string",
"description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. * `UNASSIGNED` an assignee is not set for issues created with this component. * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component.",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"description": {
"type": "string",
"description": "The description for the component. Optional when creating or updating a component."
},
"id": {
"type": "string",
"description": "The unique identifier for the component."
},
"isAssigneeTypeValid": {
"type": "boolean",
"description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned."
},
"lead": {
"description": "The user details for the component's lead user."
},
"leadAccountId": {
"type": "string",
"description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
},
"leadUserName": {
"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."
},
"metadata": {
"type": "object",
"description": "Compass component's metadata. Can't be updated. Not required for creating a Project Component."
},
"name": {
"type": "string",
"description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters."
},
"project": {
"type": "string",
"description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated."
},
"projectId": {
"type": "integer",
"description": "The ID of the project the component is assigned to."
},
"realAssignee": {
"description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee."
},
"realAssigneeType": {
"type": "string",
"description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true.",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"self": {
"type": "string",
"description": "The URL of the component."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_create\_version
Create version
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `approvers` | object\[] | No | — | If the expand option `approvers` is used, returns a list containing the approvers for this version. |
| `archived` | boolean | No | — | Indicates that the version is archived. Optional when creating or updating a version. |
| `description` | string | No | — | The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. |
| `driver` | string | No | — | The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver. |
| `expand` | string | No | — | Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: \* `operations` Returns the list of operations available for this version. \* `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*. \* `driver` Returns the Atlassian account ID of the version driver. \* `approvers` Returns a list containing approvers for this version. Optional for create and update. |
| `id` | string | No | — | The ID of the version. |
| `issuesStatusForFixVersion` | object | No | — | If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*. |
| `moveUnfixedIssuesTo` | string | No | — | The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version. |
| `name` | string | No | — | The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters. |
| `operations` | object\[] | No | — | If the expand option `operations` is used, returns the list of operations available for this version. |
| `overdue` | boolean | No | — | Indicates that the version is overdue. |
| `project` | string | No | — | Deprecated. Use `projectId`. |
| `projectId` | integer | No | — | The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version. |
| `released` | boolean | No | — | Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version. |
| `releaseDate` | string | No | — | The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. |
| `self` | string | No | — | The URL of the version. |
| `startDate` | string | No | — | The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version. |
| `userReleaseDate` | string | No | — | The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format. |
| `userStartDate` | string | No | — | The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "The Atlassian account ID of the approver."
},
"declineReason": {
"type": "string",
"description": "A description of why the user is declining the approval."
},
"description": {
"type": "string",
"description": "A description of what the user is approving within the specified version."
},
"status": {
"type": "string",
"description": "The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED*"
}
}
},
"description": "If the expand option `approvers` is used, returns a list containing the approvers for this version."
},
"archived": {
"type": "boolean",
"description": "Indicates that the version is archived. Optional when creating or updating a version."
},
"description": {
"type": "string",
"description": "The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes."
},
"driver": {
"type": "string",
"description": "The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver."
},
"expand": {
"type": "string",
"description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * `operations` Returns the list of operations available for this version. * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*. * `driver` Returns the Atlassian account ID of the version driver. * `approvers` Returns a list containing approvers for this version. Optional for create and update."
},
"id": {
"type": "string",
"description": "The ID of the version."
},
"issuesStatusForFixVersion": {
"description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*."
},
"moveUnfixedIssuesTo": {
"type": "string",
"description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version."
},
"name": {
"type": "string",
"description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters."
},
"operations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The href value"
},
"iconClass": {
"type": "string",
"description": "Icon Class"
},
"id": {
"type": "string",
"description": "The id value"
},
"label": {
"type": "string",
"description": "The label value"
},
"styleClass": {
"type": "string",
"description": "Style Class"
},
"title": {
"type": "string",
"description": "The title value"
},
"weight": {
"type": "integer",
"format": "int32",
"description": "The weight value"
}
}
},
"description": "If the expand option `operations` is used, returns the list of operations available for this version."
},
"overdue": {
"type": "boolean",
"description": "Indicates that the version is overdue."
},
"project": {
"type": "string",
"description": "Deprecated. Use `projectId`."
},
"projectId": {
"type": "integer",
"description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version."
},
"released": {
"type": "boolean",
"description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version."
},
"releaseDate": {
"type": "string",
"description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
},
"self": {
"type": "string",
"description": "The URL of the version."
},
"startDate": {
"type": "string",
"description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
},
"userReleaseDate": {
"type": "string",
"description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format."
},
"userStartDate": {
"type": "string",
"description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_all\_available\_dashboard\_gadgets
Get available gadgets
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_all\_gadgets
Get gadgets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ---------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `dashboardId` | integer | Yes | — | The ID of the dashboard. |
| `moduleKey` | string\[] | No | — | The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`. |
| `uri` | string\[] | No | — | The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`. |
| `gadgetId` | integer\[] | No | — | The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dashboardId": {
"type": "integer",
"description": "The ID of the dashboard."
},
"moduleKey": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: `moduleKey=key:one&moduleKey=key:two`."
},
"uri": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`."
},
"gadgetId": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`."
}
},
"required": [
"PCID",
"dashboardId"
]
}
```
***
## jira\_projects\_get\_all\_project\_categories
Get all project categories
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_all\_statuses
Get all statuses for project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ----------------------------------------------- |
| `projectIdOrKey` | string | Yes | — | The project ID or project key (case sensitive). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrKey": {
"type": "string",
"description": "The project ID or project key (case sensitive)."
}
},
"required": [
"PCID",
"projectIdOrKey"
]
}
```
***
## jira\_projects\_get\_component
Get component
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------ |
| `id` | string | Yes | — | The ID of the component. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the component."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## jira\_projects\_get\_dashboard
Get dashboard
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------ |
| `id` | string | Yes | — | The ID of the dashboard. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the dashboard."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## jira\_projects\_get\_dashboards\_paginated
Search for dashboards
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dashboardName` | string | No | — | String used to perform a case-insensitive partial match with `name`. |
| `accountId` | string | No | — | User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter. |
| `owner` | string | No | — | This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter. |
| `groupname` | string | No | — | As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` parameter. |
| `groupId` | string | No | — | Group ID used to return dashboards that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter. |
| `projectId` | integer | No | — | Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`. |
| `orderBy` | string | No | — | Order the results by a field: \* `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. \* `favourite_count` Sorts by dashboard popularity. \* `id` Sorts by dashboard ID. \* `is_favourite` Sorts by whether the dashboard is marked as a favorite. \* `name` Sorts by dashboard name. \* `owner` Sorts by dashboard owner name. |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
| `status` | string | No | — | The status to filter by. It may be active, archived or deleted. |
| `expand` | string | No | — | Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: \* `description` Returns the description of the dashboard. \* `owner` Returns the owner of the dashboard. \* `viewUrl` Returns the URL that is used to view the dashboard. \* `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite. \* `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite. \* `sharePermissions` Returns details of the share permissions defined for the dashboard. \* `editPermissions` Returns details of the edit permissions defined for the dashboard. \* `isWritable` Returns whether the current user has permission to edit the dashboard. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dashboardName": {
"type": "string",
"description": "String used to perform a case-insensitive partial match with `name`."
},
"accountId": {
"type": "string",
"description": "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter."
},
"owner": {
"type": "string",
"description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter."
},
"groupname": {
"type": "string",
"description": "As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` parameter."
},
"groupId": {
"type": "string",
"description": "Group ID used to return dashboards that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter."
},
"projectId": {
"type": "integer",
"description": "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`."
},
"orderBy": {
"type": "string",
"description": "[Order](#ordering) the results by a field: * `description` Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * `favourite_count` Sorts by dashboard popularity. * `id` Sorts by dashboard ID. * `is_favourite` Sorts by whether the dashboard is marked as a favorite. * `name` Sorts by dashboard name. * `owner` Sorts by dashboard owner name.",
"enum": [
"description",
"-description",
"+description",
"favorite_count",
"-favorite_count",
"+favorite_count",
"id",
"-id",
"+id",
"is_favorite",
"-is_favorite",
"+is_favorite",
"name",
"-name",
"+name",
"owner",
"-owner",
"+owner"
]
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
},
"status": {
"type": "string",
"description": "The status to filter by. It may be active, archived or deleted.",
"enum": [
"active",
"archived",
"deleted"
]
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * `description` Returns the description of the dashboard. * `owner` Returns the owner of the dashboard. * `viewUrl` Returns the URL that is used to view the dashboard. * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite. * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite. * `sharePermissions` Returns details of the share permissions defined for the dashboard. * `editPermissions` Returns details of the edit permissions defined for the dashboard. * `isWritable` Returns whether the current user has permission to edit the dashboard."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_project
Get project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `projectIdOrKey` | string | Yes | — | The project ID or project key (case sensitive). |
| `expand` | string | No | — | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: \* `description` The project description. \* `issueTypes` The issue types associated with the project. \* `lead` The project lead. \* `projectKeys` All project keys associated with the project. \* `issueTypeHierarchy` The project issue type hierarchy. |
| `properties` | string\[] | No | — | A list of project properties to return for the project. This parameter accepts a comma-separated list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrKey": {
"type": "string",
"description": "The project ID or project key (case sensitive)."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include: * `description` The project description. * `issueTypes` The issue types associated with the project. * `lead` The project lead. * `projectKeys` All project keys associated with the project. * `issueTypeHierarchy` The project issue type hierarchy."
},
"properties": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of project properties to return for the project. This parameter accepts a comma-separated list."
}
},
"required": [
"PCID",
"projectIdOrKey"
]
}
```
***
## jira\_projects\_get\_project\_components
Get project components
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `projectIdOrKey` | string | Yes | — | The project ID or project key (case sensitive). |
| `componentSource` | string | No | — | The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to `jira`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrKey": {
"type": "string",
"description": "The project ID or project key (case sensitive)."
},
"componentSource": {
"type": "string",
"description": "The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to `jira`.",
"enum": [
"jira",
"compass",
"auto"
]
}
},
"required": [
"PCID",
"projectIdOrKey"
]
}
```
***
## jira\_projects\_get\_project\_versions\_paginated
Get project versions paginated
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `projectIdOrKey` | string | Yes | — | The project ID or project key (case sensitive). |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
| `orderBy` | string | No | — | Order the results by a field: \* `description` Sorts by version description. \* `name` Sorts by version name. \* `releaseDate` Sorts by release date, starting with the oldest date. Versions with no release date are listed last. \* `sequence` Sorts by the order of appearance in the user interface. \* `startDate` Sorts by start date, starting with the oldest date. Versions with no start date are listed last. |
| `query` | string | No | — | Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive). |
| `status` | string | No | — | A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are `released`, `unreleased`, and `archived`. |
| `expand` | string | No | — | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: \* `issuesstatus` Returns the number of issues in each status category for each version. \* `operations` Returns actions that can be performed on the specified version. \* `driver` Returns the Atlassian account ID of the version driver. \* `approvers` Returns a list containing the approvers for this version. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrKey": {
"type": "string",
"description": "The project ID or project key (case sensitive)."
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
},
"orderBy": {
"type": "string",
"description": "[Order](#ordering) the results by a field: * `description` Sorts by version description. * `name` Sorts by version name. * `releaseDate` Sorts by release date, starting with the oldest date. Versions with no release date are listed last. * `sequence` Sorts by the order of appearance in the user interface. * `startDate` Sorts by start date, starting with the oldest date. Versions with no start date are listed last.",
"enum": [
"description",
"-description",
"+description",
"name",
"-name",
"+name",
"releaseDate",
"-releaseDate",
"+releaseDate",
"sequence",
"-sequence",
"+sequence",
"startDate",
"-startDate",
"+startDate"
]
},
"query": {
"type": "string",
"description": "Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive)."
},
"status": {
"type": "string",
"description": "A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are `released`, `unreleased`, and `archived`."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `issuesstatus` Returns the number of issues in each status category for each version. * `operations` Returns actions that can be performed on the specified version. * `driver` Returns the Atlassian account ID of the version driver. * `approvers` Returns a list containing the approvers for this version."
}
},
"required": [
"PCID",
"projectIdOrKey"
]
}
```
***
## jira\_projects\_get\_recent
Get recent projects
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string | No | — | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: \* `description` Returns the project description. \* `projectKeys` Returns all project keys associated with a project. \* `lead` Returns information about the project lead. \* `issueTypes` Returns all issue types associated with the project. \* `url` Returns the URL associated with the project. \* `permissions` Returns the permissions associated with the project. \* `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. \* `*` Returns the project with all available expand options. |
| `properties` | object\[] | No | — | EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * `description` Returns the project description. * `projectKeys` Returns all project keys associated with a project. * `lead` Returns information about the project lead. * `issueTypes` Returns all issue types associated with the project. * `url` Returns the URL associated with the project. * `permissions` Returns the permissions associated with the project. * `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. * `*` Returns the project with all available expand options."
},
"properties": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_status\_categories
Get all status categories
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_status\_category
Get status category
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| `idOrKey` | string | Yes | — | The ID or key of the status category. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idOrKey": {
"type": "string",
"description": "The ID or key of the status category."
}
},
"required": [
"PCID",
"idOrKey"
]
}
```
***
## jira\_projects\_get\_statuses
Get all statuses
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_projects\_get\_version
Get version
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The ID of the version. |
| `expand` | string | No | — | Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: \* `operations` Returns the list of operations available for this version. \* `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property represents the number of issues with a status other than *to do*, *in progress*, and *done*. \* `driver` Returns the Atlassian account ID of the version driver. \* `approvers` Returns a list containing the Atlassian account IDs of approvers for this version. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the version."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include: * `operations` Returns the list of operations available for this version. * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property represents the number of issues with a status other than *to do*, *in progress*, and *done*. * `driver` Returns the Atlassian account ID of the version driver. * `approvers` Returns a list containing the Atlassian account IDs of approvers for this version."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## jira\_projects\_search\_projects
Get projects paginated
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. Must be less than or equal to 100. If a value greater than 100 is provided, the `maxResults` parameter will default to 100. |
| `orderBy` | string | No | — | Order the results by a field. \* `category` Sorts by project category. A complete list of category IDs is found using Get all project categories. \* `issueCount` Sorts by the total number of issues in each project. \* `key` Sorts by project key. \* `lastIssueUpdatedTime` Sorts by the last issue update time. \* `name` Sorts by project name. \* `owner` Sorts by project lead. \* `archivedDate` EXPERIMENTAL. Sorts by project archived date. \* `deletedDate` EXPERIMENTAL. Sorts by project deleted date. |
| `id` | integer\[] | No | — | The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Up to 50 project IDs can be provided. |
| `keys` | string\[] | No | — | The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, `keys=PA&keys=PB`. Up to 50 project keys can be provided. |
| `query` | string | No | — | Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive). |
| `typeKey` | string | No | — | Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are `business`, `service_desk`, and `software`. |
| `categoryId` | integer | No | — | The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. |
| `action` | string | No | — | Filter results by projects for which the user can: \* `view` the project, meaning that they have one of the following permissions: \* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. \* *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. \* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). \* `browse` the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. \* `edit` the project, meaning that they have one of the following permissions: \* *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. \* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). \* `create` the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created. |
| `expand` | string | No | — | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: \* `description` Returns the project description. \* `projectKeys` Returns all project keys associated with a project. \* `lead` Returns information about the project lead. \* `issueTypes` Returns all issue types associated with the project. \* `url` Returns the URL associated with the project. \* `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. |
| `status` | string\[] | No | — | EXPERIMENTAL. Filter results by project status: \* `live` Search live projects. \* `archived` Search archived projects. \* `deleted` Search deleted projects, those in the recycle bin. |
| `properties` | object\[] | No | — | EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. |
| `propertyQuery` | string | No | — | EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of `nested` from `{"something":{"nested":1,"other":2}}` use `[thepropertykey].something.nested=1`. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that `thepropertykey` is only returned when included in `properties`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page. Must be less than or equal to 100. If a value greater than 100 is provided, the `maxResults` parameter will default to 100."
},
"orderBy": {
"type": "string",
"description": "[Order](#ordering) the results by a field. * `category` Sorts by project category. A complete list of category IDs is found using [Get all project categories](#api-rest-api-3-projectCategory-get). * `issueCount` Sorts by the total number of issues in each project. * `key` Sorts by project key. * `lastIssueUpdatedTime` Sorts by the last issue update time. * `name` Sorts by project name. * `owner` Sorts by project lead. * `archivedDate` EXPERIMENTAL. Sorts by project archived date. * `deletedDate` EXPERIMENTAL. Sorts by project deleted date.",
"enum": [
"category",
"-category",
"+category",
"key",
"-key",
"+key",
"name",
"-name",
"+name",
"owner",
"-owner",
"+owner",
"issueCount",
"-issueCount",
"+issueCount",
"lastIssueUpdatedDate",
"-lastIssueUpdatedDate",
"+lastIssueUpdatedDate",
"archivedDate",
"+archivedDate",
"-archivedDate",
"deletedDate",
"+deletedDate",
"-deletedDate"
]
},
"id": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Up to 50 project IDs can be provided."
},
"keys": {
"type": "array",
"items": {
"type": "string"
},
"description": "The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, `keys=PA&keys=PB`. Up to 50 project keys can be provided."
},
"query": {
"type": "string",
"description": "Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive)."
},
"typeKey": {
"type": "string",
"description": "Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are `business`, `service_desk`, and `software`."
},
"categoryId": {
"type": "integer",
"description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation."
},
"action": {
"type": "string",
"description": "Filter results by projects for which the user can: * `view` the project, meaning that they have one of the following permissions: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * `browse` the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * `edit` the project, meaning that they have one of the following permissions: * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * `create` the project, meaning that they have the *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue is created.",
"enum": [
"view",
"browse",
"edit",
"create"
]
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include: * `description` Returns the project description. * `projectKeys` Returns all project keys associated with a project. * `lead` Returns information about the project lead. * `issueTypes` Returns all issue types associated with the project. * `url` Returns the URL associated with the project. * `insight` EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project."
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"live",
"archived",
"deleted"
]
},
"description": "EXPERIMENTAL. Filter results by project status: * `live` Search live projects. * `archived` Search archived projects. * `deleted` Search deleted projects, those in the recycle bin."
},
"properties": {
"type": "array",
"items": {
"type": "object"
},
"description": "EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list."
},
"propertyQuery": {
"type": "string",
"description": "EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `[thepropertykey].something.nested=1`. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that `thepropertykey` is only returned when included in `properties`."
}
},
"required": [
"PCID"
]
}
```