API docs by Redocly

Backlog API (UNOFFICIAL) (2.0.0)

Download OpenAPI specification:

URL: https://nulab.com License: See Nulab Terms of Service

Backlog API — Project management tool by Nulab.

This is an unofficial OpenAPI specification and is not provided or endorsed by Nulab. Complete compatibility with the actual Backlog API is not guaranteed.

This definition is maintained for backlog-cli.

Backlog API Documentation

Licence & Rate Limit

Space licence information and API rate limits.

Get rate limit information

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "rateLimit": {
    }
}

Get space licence information

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "attachmentLimit": 0,
  • "attachmentLimitPerFile": 0,
  • "attachmentNumLimit": 0,
  • "attribute": true,
  • "attributeLimit": 0,
  • "burndown": true,
  • "commentLimit": 0,
  • "componentLimit": 0,
  • "fileSharing": true,
  • "gantt": true,
  • "git": true,
  • "issueLimit": 0,
  • "licenceTypeId": 0,
  • "limitDate": "2019-08-24T14:15:22Z",
  • "nulabAccount": true,
  • "parentChildIssue": true,
  • "postIssueByMail": true,
  • "projectGroup": true,
  • "projectLimit": 0,
  • "pullRequestAttachmentLimitPerFile": 0,
  • "pullRequestAttachmentNumLimit": 0,
  • "remoteAddress": true,
  • "startedOn": "2019-08-24T14:15:22Z",
  • "storageLimit": 0,
  • "subversion": true,
  • "subversionExternal": true,
  • "userLimit": 0,
  • "versionLimit": 0,
  • "wikiAttachment": true,
  • "wikiAttachmentLimitPerFile": 0,
  • "wikiAttachmentNumLimit": 0
}

Recently Viewed

Recently viewed issues, projects, and wiki pages.

Get recently viewed issues

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get recently viewed projects

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get recently viewed wiki pages

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Priorities & Resolutions

Priority and resolution master data.

Get list of priorities

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get list of resolutions

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Project Shared Files

Shared files within a project.

Get list of shared files in a directory

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
path
required
string
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download a shared file

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
sharedFileId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Custom Fields

Project custom field definitions and list items.

Get list of custom fields in the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a custom field to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
typeId
required
number (CustomFieldType)
Enum: 1 2 3 4 5 6 7 8

Custom field type code.

  • 1: Text
  • 2: TextArea
  • 3: Numeric
  • 4: Date
  • 5: SingleList
  • 6: MultipleList
  • 7: CheckBox
  • 8: RadioButton
name
required
string
description
string
required
boolean
applicableIssueTypes
Array of integers <int64> [ items <int64 > ]
min
number <double>

Min value (for Numeric type).

max
number <double>

Max value (for Numeric type).

initialValue
string

Initial value (for Numeric/Date type).

unit
string

Unit (for Numeric type).

initialValueType
integer <int32>

Initial value type for Date (1: Today, 2: Start of project, 3: End of project).

initialDate
string <date>

Initial date (for Date type).

allowInput
boolean

Allow input of items (for list types).

allowAddItem
boolean

Allow adding items (for list types).

items
Array of strings

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "typeId": 1,
  • "name": "string",
  • "description": "string",
  • "required": true,
  • "applicableIssueTypes": [
    ],
  • "allowAddItem": true,
  • "items": [
    ]
}

Update a custom field

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
customFieldId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
description
string
required
boolean
applicableIssueTypes
Array of integers <int64> [ items <int64 > ]
min
number <double>
max
number <double>
initialValue
string
unit
string
initialValueType
integer <int32>
initialDate
string <date>
allowInput
boolean
allowAddItem
boolean
items
Array of strings

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "typeId": 1,
  • "name": "string",
  • "description": "string",
  • "required": true,
  • "applicableIssueTypes": [
    ],
  • "allowAddItem": true,
  • "items": [
    ]
}

Delete a custom field

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
customFieldId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "typeId": 1,
  • "name": "string",
  • "description": "string",
  • "required": true,
  • "applicableIssueTypes": [
    ],
  • "allowAddItem": true,
  • "items": [
    ]
}

Add a list item to a custom field

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
customFieldId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "displayOrder": 0
}

Update a list item of a custom field

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
customFieldId
required
integer <int64>
itemId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "displayOrder": 0
}

Delete a list item from a custom field

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
customFieldId
required
integer <int64>
itemId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "displayOrder": 0
}

Versions / Milestones

Project versions and milestones.

Get list of versions/milestones in the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a version/milestone to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
description
string
startDate
string <date>
releaseDueDate
string <date>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24",
  • "releaseDueDate": "2019-08-24",
  • "archived": true,
  • "displayOrder": 0
}

Update a version/milestone

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
versionId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
description
string
startDate
string <date>
releaseDueDate
string <date>
archived
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24",
  • "releaseDueDate": "2019-08-24",
  • "archived": true,
  • "displayOrder": 0
}

Delete a version/milestone

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
versionId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "startDate": "2019-08-24",
  • "releaseDueDate": "2019-08-24",
  • "archived": true,
  • "displayOrder": 0
}

Categories

Project categories.

Get list of categories in the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a category to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "displayOrder": 0
}

Update a category

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
categoryId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "displayOrder": 0
}

Delete a category

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
categoryId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "displayOrder": 0
}

Issue Types

Project issue types.

Get list of issue types in the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add an issue type to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
color
required
string
templateSummary
string
templateDescription
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "color": "string",
  • "displayOrder": 0,
  • "templateSummary": "string",
  • "templateDescription": "string"
}

Update an issue type

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
issueTypeId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
color
string
templateSummary
string
templateDescription
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "color": "string",
  • "displayOrder": 0,
  • "templateSummary": "string",
  • "templateDescription": "string"
}

Delete an issue type

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
issueTypeId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
substituteIssueTypeId
required
integer <int64>

Substitute issue type ID: issues with the deleted type will be moved to this type.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "color": "string",
  • "displayOrder": 0,
  • "templateSummary": "string",
  • "templateDescription": "string"
}

Statuses

Project issue statuses.

Get list of statuses in the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a status to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
color
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "color": "string",
  • "displayOrder": 0
}

Update display order of statuses

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
statusId
required
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a status

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
statusId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
color
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "color": "string",
  • "displayOrder": 0
}

Delete a status

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
statusId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
substituteStatusId
required
integer <int64>

Substitute status ID: issues with the deleted status will be moved to this status.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "color": "string",
  • "displayOrder": 0
}

Stars

Star (favorite) operations for issues, comments, wikis, and pull requests.

Add a star

Add a star to an issue, comment, wiki page, or pull request.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
issueId
integer <int64>

Issue ID to star.

commentId
integer <int64>

Comment ID to star.

wikiId
integer <int64>

Wiki page ID to star.

pullRequestId
integer <int64>

Pull request ID to star.

pullRequestCommentId
integer <int64>

Pull request comment ID to star.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Webhooks

Webhook management within projects.

Get list of webhooks in a project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a webhook to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
description
string
hookUrl
required
string
allEvent
boolean
activityTypeIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "hookUrl": "string",
  • "allEvent": true,
  • "activityTypeIds": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Get webhook information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
webhookId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "hookUrl": "string",
  • "allEvent": true,
  • "activityTypeIds": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Update a webhook

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
webhookId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
description
string
hookUrl
string
allEvent
boolean
activityTypeIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "hookUrl": "string",
  • "allEvent": true,
  • "activityTypeIds": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Delete a webhook

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
webhookId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "hookUrl": "string",
  • "allEvent": true,
  • "activityTypeIds": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Watching

Watching (follow) management for issues.

Get list of watchings for a user

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

resourceAlreadyRead
boolean
sort
string
Enum: "created" "updated" "issueUpdated"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a watching

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
issueIdOrKey
required
string
note
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "resourceAlreadyRead": true,
  • "note": "string",
  • "type": "string",
  • "issue": {
    },
  • "lastContentUpdated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get count of watchings

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
alreadyRead
boolean
resourceAlreadyRead
boolean

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get a watching

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
watchingId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "resourceAlreadyRead": true,
  • "note": "string",
  • "type": "string",
  • "issue": {
    },
  • "lastContentUpdated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Update a watching

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
watchingId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
note
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "resourceAlreadyRead": true,
  • "note": "string",
  • "type": "string",
  • "issue": {
    },
  • "lastContentUpdated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Delete a watching

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
watchingId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "resourceAlreadyRead": true,
  • "note": "string",
  • "type": "string",
  • "issue": {
    },
  • "lastContentUpdated": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Mark a watching as read

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
watchingId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Wiki Shared Files

Shared files linked to wiki pages.

Get list of shared files linked to a wiki page

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Wiki Attachments

Attachments on wiki pages.

Get list of wiki page attachments

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attach files to a wiki page

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
attachmentId
required
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download a wiki page attachment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>
attachmentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete a wiki page attachment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>
attachmentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "size": 0
}

Wikis

Wiki page management: list, create, update, delete pages.

Get list of wiki pages

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
projectIdOrKey
string
keyword
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new wiki page

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
projectId
required
integer <int64>
name
required
string
content
required
string
mailNotify
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "content": "string",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Get count of wiki pages

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
projectIdOrKey
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get list of wiki tags

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
projectIdOrKey
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get wiki page information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "content": "string",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Update a wiki page

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
content
string
mailNotify
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "content": "string",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Delete a wiki page

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>
query Parameters
mailNotify
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "content": "string",
  • "tags": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Get wiki page update history

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

minId
integer <int64>
maxId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get list of stars on a wiki page

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
wikiId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pull Request Attachments

Attachments on pull requests.

Get list of attachments on a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download a pull request attachment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>
attachmentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete a pull request attachment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>
attachmentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "size": 0
}

Pull Request Comments

Comments on pull requests.

Get list of comments on a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

minId
integer <int64>
maxId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a comment to a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
content
required
string
notifiedUserId
Array of integers <int64> [ items <int64 > ]
attachmentId
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Get count of comments on a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Update a pull request comment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>
commentId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
content
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Pull Requests

Pull request management within Git repositories.

Get list of pull requests

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
query Parameters
statusId[]
Array of numbers (PullRequestStatusType)
Items Enum: 1 2 3
assigneeId
integer <int64>
issueId
integer <int64>
createdUserId
integer <int64>
offset
integer <int32>
count
integer <int32> [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
Request Body schema: application/x-www-form-urlencoded
required
summary
required
string
description
required
string
base
required
string
branch
required
string
issueId
integer <int64>
assigneeId
integer <int64>
notifiedUserId
Array of integers <int64> [ items <int64 > ]
attachmentId
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "repositoryId": 0,
  • "number": 0,
  • "summary": "string",
  • "description": "string",
  • "base": "string",
  • "branch": "string",
  • "status": {
    },
  • "assignee": {
    },
  • "issue": {
    },
  • "baseCommit": "string",
  • "branchCommit": "string",
  • "mergeCommit": "string",
  • "closeAt": "2019-08-24T14:15:22Z",
  • "mergeAt": "2019-08-24T14:15:22Z",
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "attachments": [
    ],
  • "stars": [
    ]
}

Get count of pull requests

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
query Parameters
statusId[]
Array of numbers (PullRequestStatusType)
Items Enum: 1 2 3
assigneeId
integer <int64>
issueId
integer <int64>
createdUserId
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "repositoryId": 0,
  • "number": 0,
  • "summary": "string",
  • "description": "string",
  • "base": "string",
  • "branch": "string",
  • "status": {
    },
  • "assignee": {
    },
  • "issue": {
    },
  • "baseCommit": "string",
  • "branchCommit": "string",
  • "mergeCommit": "string",
  • "closeAt": "2019-08-24T14:15:22Z",
  • "mergeAt": "2019-08-24T14:15:22Z",
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "attachments": [
    ],
  • "stars": [
    ]
}

Update a pull request

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
summary
string
description
string
issueId
integer <int64>
assigneeId
integer <int64>
notifiedUserId
Array of integers <int64> [ items <int64 > ]
comment
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "repositoryId": 0,
  • "number": 0,
  • "summary": "string",
  • "description": "string",
  • "base": "string",
  • "branch": "string",
  • "status": {
    },
  • "assignee": {
    },
  • "issue": {
    },
  • "baseCommit": "string",
  • "branchCommit": "string",
  • "mergeCommit": "string",
  • "closeAt": "2019-08-24T14:15:22Z",
  • "mergeAt": "2019-08-24T14:15:22Z",
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "attachments": [
    ],
  • "stars": [
    ]
}

Git Repositories

Git repository management within projects.

Get list of Git repositories in a project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a Git repository

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
repoIdOrName
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "name": "string",
  • "description": "string",
  • "hookUrl": "string",
  • "httpUrl": "string",
  • "sshUrl": "string",
  • "displayOrder": 0,
  • "pushedAt": "2019-08-24T14:15:22Z",
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Notifications

Notification management and read status.

Get list of notifications

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
minId
integer <int64>
maxId
integer <int64>
count
integer <int32> [ 1 .. 100 ]
Default: 20
order
string (Order)
Enum: "asc" "desc"

Sort order direction.

resourceAlreadyRead
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get count of unread notifications

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
alreadyRead
boolean
resourceAlreadyRead
boolean

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Mark all notifications as read

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Mark a specific notification as read

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
notificationId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Issue Shared Files

Shared files linked to issues.

Get list of shared files linked to an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Issue Participants

Participants on issues.

Get list of participants on an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Issue Attachments

Attachments on issues.

Get list of attachments on an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download an issue attachment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
attachmentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete an issue attachment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
attachmentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "size": 0
}

Issue Comments

Comments on issues.

Get list of comments on an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

minId
integer <int64>
maxId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a comment to an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
content
required
string
notifiedUserId
Array of integers <int64> [ items <int64 > ]
attachmentId
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Get count of comments on an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get a specific comment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
commentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Update a comment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
commentId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
content
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Delete a comment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
commentId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Get list of notifications for a comment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
commentId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add notifications to a comment

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
commentId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
notifiedUserId
required
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "content": "string",
  • "changeLog": [
    ],
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "stars": [
    ],
  • "notifications": [
    ]
}

Issues

Issue management: list, create, update, delete issues.

Get list of issues

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
projectId[]
Array of integers <int64> [ items <int64 > ]
issueTypeId[]
Array of integers <int64> [ items <int64 > ]
categoryId[]
Array of integers <int64> [ items <int64 > ]
versionId[]
Array of integers <int64> [ items <int64 > ]
milestoneId[]
Array of integers <int64> [ items <int64 > ]
statusId[]
Array of integers <int64> [ items <int64 > ]
priorityId[]
Array of integers <int64> [ items <int64 > ]
assigneeId[]
Array of integers <int64> [ items <int64 > ]
createdUserId[]
Array of integers <int64> [ items <int64 > ]
resolutionId[]
Array of integers <int64> [ items <int64 > ]
parentChild
number (ParentChildType)
Enum: 0 1 2 3 4

Parent/child issue filter.

  • 0: All
  • 1: Exclude child issues
  • 2: Only child issues
  • 3: Neither parent nor child
  • 4: Only parent issues
attachment
boolean
sharedFile
boolean
sort
string (IssueSortField)
Enum: "issueType" "category" "version" "milestone" "summary" "status" "priority" "attachment" "sharedFile" "created" "createdUser" "updated" "updatedUser" "assignee" "startDate" "dueDate" "estimatedHours" "actualHours" "childIssue"

Sort field for issue list.

order
string (Order)
Enum: "asc" "desc"

Sort order direction.

offset
integer <int32> >= 0
count
integer <int32> [ 1 .. 100 ]
Default: 20
createdSince
string <date>
createdUntil
string <date>
updatedSince
string <date>
updatedUntil
string <date>
startDateSince
string <date>
startDateUntil
string <date>
dueDateSince
string <date>
dueDateUntil
string <date>
id[]
Array of integers <int64> [ items <int64 > ]
parentIssueId[]
Array of integers <int64> [ items <int64 > ]
keyword
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new issue

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
projectId
required
integer <int64>
summary
required
string
parentIssueId
integer <int64>
description
string
startDate
string <date>
dueDate
string <date>
estimatedHours
number <double>
actualHours
number <double>
issueTypeId
required
integer <int64>
categoryId
Array of integers <int64> [ items <int64 > ]
versionId
Array of integers <int64> [ items <int64 > ]
milestoneId
Array of integers <int64> [ items <int64 > ]
priorityId
required
integer <int64>
assigneeId
integer <int64>
notifiedUserId
Array of integers <int64> [ items <int64 > ]
attachmentId
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "issueKey": "string",
  • "keyId": 0,
  • "issueType": {
    },
  • "summary": "string",
  • "description": "string",
  • "resolution": {
    },
  • "priority": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "category": [
    ],
  • "versions": [
    ],
  • "milestone": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "estimatedHours": 0.1,
  • "actualHours": 0.1,
  • "parentIssueId": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ]
}

Get count of issues

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
projectId[]
Array of integers <int64> [ items <int64 > ]
issueTypeId[]
Array of integers <int64> [ items <int64 > ]
categoryId[]
Array of integers <int64> [ items <int64 > ]
versionId[]
Array of integers <int64> [ items <int64 > ]
milestoneId[]
Array of integers <int64> [ items <int64 > ]
statusId[]
Array of integers <int64> [ items <int64 > ]
priorityId[]
Array of integers <int64> [ items <int64 > ]
assigneeId[]
Array of integers <int64> [ items <int64 > ]
createdUserId[]
Array of integers <int64> [ items <int64 > ]
resolutionId[]
Array of integers <int64> [ items <int64 > ]
parentChild
number (ParentChildType)
Enum: 0 1 2 3 4

Parent/child issue filter.

  • 0: All
  • 1: Exclude child issues
  • 2: Only child issues
  • 3: Neither parent nor child
  • 4: Only parent issues
attachment
boolean
sharedFile
boolean
createdSince
string <date>
createdUntil
string <date>
updatedSince
string <date>
updatedUntil
string <date>
startDateSince
string <date>
startDateUntil
string <date>
dueDateSince
string <date>
dueDateUntil
string <date>
id[]
Array of integers <int64> [ items <int64 > ]
parentIssueId[]
Array of integers <int64> [ items <int64 > ]
keyword
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get issue information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "issueKey": "string",
  • "keyId": 0,
  • "issueType": {
    },
  • "summary": "string",
  • "description": "string",
  • "resolution": {
    },
  • "priority": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "category": [
    ],
  • "versions": [
    ],
  • "milestone": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "estimatedHours": 0.1,
  • "actualHours": 0.1,
  • "parentIssueId": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ]
}

Update an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
summary
string
parentIssueId
integer <int64>
description
string
statusId
integer <int64>
resolutionId
integer <int64>
startDate
string <date>
dueDate
string <date>
estimatedHours
number <double>
actualHours
number <double>
issueTypeId
integer <int64>
categoryId
Array of integers <int64> [ items <int64 > ]
versionId
Array of integers <int64> [ items <int64 > ]
milestoneId
Array of integers <int64> [ items <int64 > ]
priorityId
integer <int64>
assigneeId
integer <int64>
notifiedUserId
Array of integers <int64> [ items <int64 > ]
attachmentId
Array of integers <int64> [ items <int64 > ]
comment
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "issueKey": "string",
  • "keyId": 0,
  • "issueType": {
    },
  • "summary": "string",
  • "description": "string",
  • "resolution": {
    },
  • "priority": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "category": [
    ],
  • "versions": [
    ],
  • "milestone": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "estimatedHours": 0.1,
  • "actualHours": 0.1,
  • "parentIssueId": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ]
}

Delete an issue

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
issueIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectId": 0,
  • "issueKey": "string",
  • "keyId": 0,
  • "issueType": {
    },
  • "summary": "string",
  • "description": "string",
  • "resolution": {
    },
  • "priority": {
    },
  • "status": {
    },
  • "assignee": {
    },
  • "category": [
    ],
  • "versions": [
    ],
  • "milestone": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "estimatedHours": 0.1,
  • "actualHours": 0.1,
  • "parentIssueId": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "attachments": [
    ],
  • "sharedFiles": [
    ],
  • "stars": [
    ]
}

Project Administrators

Manage project administrators.

Get list of project administrators

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a project administrator

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Remove a project administrator

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Project Members

Manage project members.

Get list of project members

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
query Parameters
excludeGroupMembers
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a user to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Remove a user from the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Projects

Project management: list, create, update, delete projects and retrieve project activities.

Get list of projects

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
archived
boolean
all
boolean

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new project

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
key
required
string
chartEnabled
boolean
subtaskingEnabled
boolean
projectLeaderCanEditProjectLeader
boolean
useWiki
boolean
useFileSharing
boolean
useDevAttributes
boolean
textFormattingRule
string (TextFormattingRule)
Enum: "backlog" "markdown"

Text formatting rule for spaces and projects.

useWikiTreeView
boolean
useOriginalImageSizeAtWiki
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectKey": "string",
  • "name": "string",
  • "chartEnabled": true,
  • "useResolvedForChart": true,
  • "subtaskingEnabled": true,
  • "projectLeaderCanEditProjectLeader": true,
  • "useWiki": true,
  • "useFileSharing": true,
  • "useWikiTreeView": true,
  • "useOriginalImageSizeAtWiki": true,
  • "useSubversion": true,
  • "useGit": true,
  • "textFormattingRule": "backlog",
  • "archived": true,
  • "displayOrder": 0,
  • "useDevAttributes": true
}

Get project information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectKey": "string",
  • "name": "string",
  • "chartEnabled": true,
  • "useResolvedForChart": true,
  • "subtaskingEnabled": true,
  • "projectLeaderCanEditProjectLeader": true,
  • "useWiki": true,
  • "useFileSharing": true,
  • "useWikiTreeView": true,
  • "useOriginalImageSizeAtWiki": true,
  • "useSubversion": true,
  • "useGit": true,
  • "textFormattingRule": "backlog",
  • "archived": true,
  • "displayOrder": 0,
  • "useDevAttributes": true
}

Update project information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
name
string
key
string
chartEnabled
boolean
subtaskingEnabled
boolean
projectLeaderCanEditProjectLeader
boolean
useWiki
boolean
useFileSharing
boolean
useDevAttributes
boolean
textFormattingRule
string (TextFormattingRule)
Enum: "backlog" "markdown"

Text formatting rule for spaces and projects.

archived
boolean
useWikiTreeView
boolean
useOriginalImageSizeAtWiki
boolean

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectKey": "string",
  • "name": "string",
  • "chartEnabled": true,
  • "useResolvedForChart": true,
  • "subtaskingEnabled": true,
  • "projectLeaderCanEditProjectLeader": true,
  • "useWiki": true,
  • "useFileSharing": true,
  • "useWikiTreeView": true,
  • "useOriginalImageSizeAtWiki": true,
  • "useSubversion": true,
  • "useGit": true,
  • "textFormattingRule": "backlog",
  • "archived": true,
  • "displayOrder": 0,
  • "useDevAttributes": true
}

Delete a project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "projectKey": "string",
  • "name": "string",
  • "chartEnabled": true,
  • "useResolvedForChart": true,
  • "subtaskingEnabled": true,
  • "projectLeaderCanEditProjectLeader": true,
  • "useWiki": true,
  • "useFileSharing": true,
  • "useWikiTreeView": true,
  • "useOriginalImageSizeAtWiki": true,
  • "useSubversion": true,
  • "useGit": true,
  • "textFormattingRule": "backlog",
  • "archived": true,
  • "displayOrder": 0,
  • "useDevAttributes": true
}

Get project activities

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
query Parameters
minId
integer <int64>

Minimum activity ID (exclusive).

maxId
integer <int64>

Maximum activity ID (exclusive).

count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

order
string (Order)
Enum: "asc" "desc"

Sort order.

activityTypeId[]
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get project disk usage

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "projectId": 0,
  • "issue": 0,
  • "wiki": 0,
  • "file": 0,
  • "subversion": 0,
  • "git": 0,
  • "gitLFS": 0,
  • "pullRequest": 0
}

Get project icon image

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Groups (Deprecated)

Deprecated group endpoints. Use Teams instead.

Get list of groups

Deprecated: use Teams instead.

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get group information

Deprecated: use Teams instead.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
groupId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Project Teams

Manage teams assigned to a project.

Get list of project teams

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a team to the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
Request Body schema: application/x-www-form-urlencoded
required
teamId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Remove a team from the project

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
projectIdOrKey
required
string
teamId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Teams

Team management: list, create, update, delete teams.

Get list of teams

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new team

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
name
required
string
members
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Get team information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
teamId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Update a team

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
teamId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
name
string
members
Array of integers <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Delete a team

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
teamId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "members": [
    ],
  • "displayOrder": 0,
  • "createdUser": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "updatedUser": {
    },
  • "updated": "2019-08-24T14:15:22Z"
}

Get team icon image

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
teamId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Users

User management: list, create, update, delete users and retrieve user activities.

Get list of users in the space

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new user to the space

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
userId
required
string
password
required
string
name
required
string
mailAddress
required
string
roleType
required
number (UserRoleType)
Enum: 1 2 3 4 5 6

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Get own user information

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Get user information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Update user information

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>
Request Body schema: application/x-www-form-urlencoded
required
password
string
name
string
mailAddress
string
roleType
number (UserRoleType)
Enum: 1 2 3 4 5 6

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Delete a user from the space

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userId": "string",
  • "name": "string",
  • "roleType": 1,
  • "lang": "string",
  • "mailAddress": "string",
  • "lastLoginTime": "2019-08-24T14:15:22Z",
  • "nulabAccount": {
    }
}

Get user's recent activities

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>
query Parameters
minId
integer <int64>

Minimum activity ID (exclusive).

maxId
integer <int64>

Maximum activity ID (exclusive).

count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get user icon image

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get list of stars the user received

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>
query Parameters
count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

offset
integer <int32> >= 0

Number of records to skip.

order
string (Order)
Enum: "asc" "desc"

Sort order.

minId
integer <int64>
maxId
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get count of stars the user received

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
userId
required
integer <int64>
query Parameters
since
string <date>
until
string <date>

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Space

Space-level information, activities, disk usage, and attachments.

Get space information

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "spaceKey": "string",
  • "name": "string",
  • "ownerId": 0,
  • "lang": "string",
  • "timezone": "string",
  • "reportSendTime": "string",
  • "textFormattingRule": "backlog",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get recent space activities

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
minId
integer <int64>

Minimum activity ID (exclusive).

maxId
integer <int64>

Maximum activity ID (exclusive).

count
integer <int32> [ 1 .. 100 ]
Default: 20

Number of records to return (1–100, default: 20).

order
string (Order)
Enum: "asc" "desc"

Sort order.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload an attachment file

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "size": 0
}

Get disk usage information

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "capacity": 0,
  • "issue": 0,
  • "wiki": 0,
  • "file": 0,
  • "subversion": 0,
  • "git": 0,
  • "gitLFS": 0,
  • "pullRequest": 0,
  • "details": [
    ]
}

Get space notification

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Update space notification

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/x-www-form-urlencoded
required
content
required
string

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "updated": "2019-08-24T14:15:22Z"
}