/confluence-spaces | Type: Application | PCID required: Yes
Tools
confluence-spaces_check_access_by_email
Check site access for a list of emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
emails | string[] | Yes | — | List of emails to check access to site. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of emails to check access to site."
}
},
"required": [
"PCID",
"emails"
]
}
confluence-spaces_create_bulk_user_lookup
Create bulk user lookup using ids Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountIds | string[] | Yes | — | List of accountIds to retrieve user info for. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of accountIds to retrieve user info for."
}
},
"required": [
"PCID",
"accountIds"
]
}
confluence-spaces_create_space
Create space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | No | — | This field will be used as the new identifier for the space in confluence page URLs. If the alias property is not provided, the key property is required to be used instead. Maximum 255 alphanumeric characters in length. |
copySpaceAccessConfiguration | integer | No | — | The id of the space to copy the space access configuration from. |
createPrivateSpace | boolean | No | — | Whether to create the space as private. |
description | object | No | — | The description of the new/updated space. Note, only the ‘plain’ representation is currently supported. |
key | string | No | — | The key for the new space. See Space Keys. If the key property is not provided, the alias property is required to be used instead. |
name | string | Yes | — | The name of the space to be created. |
roleAssignments | any[] | No | — | Role Assignments |
templateKey | string | No | — | The key of the template to use. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alias": {
"type": "string",
"description": "This field will be used as the new identifier for the space in confluence page URLs. If the alias property is not provided, the key property is required to be used instead. Maximum 255 alphanumeric characters in length."
},
"copySpaceAccessConfiguration": {
"type": "integer",
"description": "The id of the space to copy the space access configuration from."
},
"createPrivateSpace": {
"type": "boolean",
"description": "Whether to create the space as private."
},
"description": {
"type": "object",
"description": "The description of the new/updated space. Note, only the 'plain' representation is currently supported.",
"properties": {
"value": {
"type": "string",
"description": "The space description."
},
"representation": {
"type": "string",
"description": "The format of the description."
}
}
},
"key": {
"type": "string",
"description": "The key for the new space. See [Space Keys](https://support.atlassian.com/confluence-cloud/docs/create-a-space/). If the key property is not provided, the alias property is required to be used instead."
},
"name": {
"type": "string",
"description": "The name of the space to be created."
},
"roleAssignments": {
"type": "array",
"description": "Role Assignments"
},
"templateKey": {
"type": "string",
"description": "The key of the template to use."
}
},
"required": [
"PCID",
"name"
]
}
confluence-spaces_delete_attachment
Delete attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the attachment to be deleted. |
purge | boolean | No | — | If attempting to purge the attachment. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the attachment to be deleted."
},
"purge": {
"type": "boolean",
"description": "If attempting to purge the attachment."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_attachment_by_id
Get attachment by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the attachment to be returned. If you don’t know the attachment’s ID, use Get attachments for page/blogpost/custom content. |
contentVersion | integer | No | — | Allows you to retrieve a previously published version. Specify the previous version’s number to retrieve its details. |
include-labels | boolean | No | — | Includes labels associated with this attachment in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-properties | boolean | No | — | Includes content properties associated with this attachment in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-operations | boolean | No | — | Includes operations associated with this attachment in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-versions | boolean | No | — | Includes versions associated with this attachment in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-version | boolean | No | — | Includes the current version associated with this attachment in the response. By default this is included and can be omitted by setting the value to false. |
include-collaborators | boolean | No | — | Includes collaborators on the attachment. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the attachment to be returned. If you don't know the attachment's ID, use Get attachments for page/blogpost/custom content."
},
"contentVersion": {
"type": "integer",
"description": "Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details."
},
"include-labels": {
"type": "boolean",
"description": "Includes labels associated with this attachment in the response. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-properties": {
"type": "boolean",
"description": "Includes content properties associated with this attachment in the response. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-operations": {
"type": "boolean",
"description": "Includes operations associated with this attachment in the response, as defined in the `Operation` object. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-versions": {
"type": "boolean",
"description": "Includes versions associated with this attachment in the response. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-version": {
"type": "boolean",
"description": "Includes the current version associated with this attachment in the response. By default this is included and can be omitted by setting the value to `false`."
},
"include-collaborators": {
"type": "boolean",
"description": "Includes collaborators on the attachment."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_attachment_labels
Get labels for attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the attachment for which labels should be returned. |
prefix | string | No | — | Filter the results to labels based on their prefix. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the attachment for which labels should be returned."
},
"prefix": {
"type": "string",
"description": "Filter the results to labels based on their prefix.",
"enum": [
"my",
"team",
"global",
"system"
]
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_attachments
Get attachments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
status | string[] | No | — | Filter the results to attachments based on their status. By default, current and archived are used. |
mediaType | string | No | — | Filters on the mediaType of attachments. Only one may be specified. |
filename | string | No | — | Filters on the file-name of attachments. Only one may be specified. |
limit | integer | No | — | Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field.",
"enum": [
"created-date",
"-created-date",
"modified-date",
"-modified-date"
]
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"current",
"archived",
"trashed"
]
},
"description": "Filter the results to attachments based on their status. By default, `current` and `archived` are used."
},
"mediaType": {
"type": "string",
"description": "Filters on the mediaType of attachments. Only one may be specified."
},
"filename": {
"type": "string",
"description": "Filters on the file-name of attachments. Only one may be specified."
},
"limit": {
"type": "integer",
"description": "Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID"
]
}
confluence-spaces_get_available_space_permissions
Get available space permissions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of space permissions to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of space permissions to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID"
]
}
confluence-spaces_get_blog_post_attachments
Get attachments for blog post Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the blog post for which attachments should be returned. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
status | string[] | No | — | Filter the results to attachments based on their status. By default, current and archived are used. |
mediaType | string | No | — | Filters on the mediaType of attachments. Only one may be specified. |
filename | string | No | — | Filters on the file-name of attachments. Only one may be specified. |
limit | integer | No | — | Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the blog post for which attachments should be returned."
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field.",
"enum": [
"created-date",
"-created-date",
"modified-date",
"-modified-date"
]
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"current",
"archived",
"trashed"
]
},
"description": "Filter the results to attachments based on their status. By default, `current` and `archived` are used."
},
"mediaType": {
"type": "string",
"description": "Filters on the mediaType of attachments. Only one may be specified."
},
"filename": {
"type": "string",
"description": "Filters on the file-name of attachments. Only one may be specified."
},
"limit": {
"type": "integer",
"description": "Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_blog_post_labels
Get labels for blog post Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the blog post for which labels should be returned. |
prefix | string | No | — | Filter the results to labels based on their prefix. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the blog post for which labels should be returned."
},
"prefix": {
"type": "string",
"description": "Filter the results to labels based on their prefix.",
"enum": [
"my",
"team",
"global",
"system"
]
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_labels
Get labels Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label-id | integer[] | No | — | Filters on label ID. Multiple IDs can be specified as a comma-separated list. |
prefix | string[] | No | — | Filters on label prefix. Multiple IDs can be specified as a comma-separated list. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
sort | string | No | — | Used to sort the result by a particular field. |
limit | integer | No | — | Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"label-id": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Filters on label ID. Multiple IDs can be specified as a comma-separated list."
},
"prefix": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filters on label prefix. Multiple IDs can be specified as a comma-separated list."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID"
]
}
confluence-spaces_get_page_attachments
Get attachments for page Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the page for which attachments should be returned. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
status | string[] | No | — | Filter the results to attachments based on their status. By default, current and archived are used. |
mediaType | string | No | — | Filters on the mediaType of attachments. Only one may be specified. |
filename | string | No | — | Filters on the file-name of attachments. Only one may be specified. |
limit | integer | No | — | Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the page for which attachments should be returned."
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field.",
"enum": [
"created-date",
"-created-date",
"modified-date",
"-modified-date"
]
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"current",
"archived",
"trashed"
]
},
"description": "Filter the results to attachments based on their status. By default, `current` and `archived` are used."
},
"mediaType": {
"type": "string",
"description": "Filters on the mediaType of attachments. Only one may be specified."
},
"filename": {
"type": "string",
"description": "Filters on the file-name of attachments. Only one may be specified."
},
"limit": {
"type": "integer",
"description": "Maximum number of attachments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_page_labels
Get labels for page Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the page for which labels should be returned. |
prefix | string | No | — | Filter the results to labels based on their prefix. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the page for which labels should be returned."
},
"prefix": {
"type": "string",
"description": "Filter the results to labels based on their prefix.",
"enum": [
"my",
"team",
"global",
"system"
]
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_space_by_id
Get space by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the space to be returned. |
description-format | string | No | — | The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field. |
include-icon | boolean | No | — | If the icon for the space should be fetched or not. |
include-operations | boolean | No | — | Includes operations associated with this space in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-properties | boolean | No | — | Includes space properties associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-permissions | boolean | No | — | Includes space permissions associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-role-assignments | boolean | No | — | Includes role assignments associated with this space in the response. This parameter is only accepted for EAP sites. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
include-labels | boolean | No | — | Includes labels associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the space to be returned."
},
"description-format": {
"type": "string",
"description": "The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field.",
"enum": [
"plain",
"view"
]
},
"include-icon": {
"type": "boolean",
"description": "If the icon for the space should be fetched or not."
},
"include-operations": {
"type": "boolean",
"description": "Includes operations associated with this space in the response, as defined in the `Operation` object. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-properties": {
"type": "boolean",
"description": "Includes space properties associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-permissions": {
"type": "boolean",
"description": "Includes space permissions associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-role-assignments": {
"type": "boolean",
"description": "Includes role assignments associated with this space in the response. This parameter is only accepted for EAP sites. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
},
"include-labels": {
"type": "boolean",
"description": "Includes labels associated with this space in the response. The number of results will be limited to 50 and sorted in the default sort order. A `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_space_content_labels
Get labels for space content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the space for which labels should be returned. |
prefix | string | No | — | Filter the results to labels based on their prefix. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the space for which labels should be returned."
},
"prefix": {
"type": "string",
"description": "Filter the results to labels based on their prefix.",
"enum": [
"my",
"team"
]
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_space_labels
Get labels for space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the space for which labels should be returned. |
prefix | string | No | — | Filter the results to labels based on their prefix. |
sort | string | No | — | Used to sort the result by a particular field. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the space for which labels should be returned."
},
"prefix": {
"type": "string",
"description": "Filter the results to labels based on their prefix.",
"enum": [
"my",
"team"
]
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of labels per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_space_permissions_assignments
Get space permissions assignments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the space to be returned. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of assignments to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the space to be returned."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of assignments to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID",
"id"
]
}
confluence-spaces_get_spaces
Get spaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | integer[] | No | — | Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list. |
keys | string[] | No | — | Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list. |
type | string | No | — | Filter the results to spaces based on their type. |
status | string | No | — | Filter the results to spaces based on their status. |
labels | string[] | No | — | Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list. |
favorited-by | string | No | — | Filter the results to spaces favorited by the user with the specified account ID. |
not-favorited-by | string | No | — | Filter the results to spaces NOT favorited by the user with the specified account ID. |
sort | string | No | — | Used to sort the result by a particular field. |
description-format | string | No | — | The content format type to be returned in the description field of the response. If available, the representation will be available under a response field of the same name under the description field. |
include-icon | boolean | No | — | If the icon for the space should be fetched or not. |
cursor | string | No | — | Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results. |
limit | integer | No | — | Maximum number of spaces per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Filter the results to spaces based on their IDs. Multiple IDs can be specified as a comma-separated list."
},
"keys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter the results to spaces based on their keys. Multiple keys can be specified as a comma-separated list."
},
"type": {
"type": "string",
"description": "Filter the results to spaces based on their type.",
"enum": [
"global",
"collaboration",
"knowledge_base",
"personal",
"system",
"onboarding",
"xflow_sample_space"
]
},
"status": {
"type": "string",
"description": "Filter the results to spaces based on their status.",
"enum": [
"current",
"archived"
]
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter the results to spaces based on their labels. Multiple labels can be specified as a comma-separated list."
},
"favorited-by": {
"type": "string",
"description": "Filter the results to spaces favorited by the user with the specified account ID."
},
"not-favorited-by": {
"type": "string",
"description": "Filter the results to spaces NOT favorited by the user with the specified account ID."
},
"sort": {
"type": "string",
"description": "Used to sort the result by a particular field.",
"enum": [
"id",
"-id",
"key",
"-key",
"name",
"-name"
]
},
"description-format": {
"type": "string",
"description": "The content format type to be returned in the `description` field of the response. If available, the representation will be available under a response field of the same name under the `description` field.",
"enum": [
"plain",
"view"
]
},
"include-icon": {
"type": "boolean",
"description": "If the icon for the space should be fetched or not."
},
"cursor": {
"type": "string",
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of spaces per result to return. If more results exist, use the `Link` response header to retrieve a relative URL that will return the next set of results."
}
},
"required": [
"PCID"
]
}