Features API
This page describes how to work with Features using REST API
Using the Features API
get
Query parameters
GetRefsbooleanOptional
SprintlessbooleanOptional
OnlyActivebooleanOptional
OnlyArchivedbooleanOptional
OnlyBacklogbooleanOptional
catstring[]Optional
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
200
Success
application/json
pagesCountinteger · int32Optional
pageSizeinteger · int32Optional
currentPageinteger · int32Optional
totalItemsCountinteger · int32Optional
get/api/v1/features
200
Success
post
Query parameters
notifyCustomersbooleanOptionalDefault:
falseBody
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring · nullableOptional
namestring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
Responses
200
Success
application/json
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring · nullableOptional
namestring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
post/api/v1/features
200
Success
get
Query parameters
GetRefsbooleanOptional
SprintlessbooleanOptional
OnlyActivebooleanOptional
OnlyArchivedbooleanOptional
OnlyBacklogbooleanOptional
catstring[]Optional
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
200
Success
application/json
pagesCountinteger · int32Optional
pageSizeinteger · int32Optional
currentPageinteger · int32Optional
totalItemsCountinteger · int32Optional
get/api/v1/features/advanced
200
Success
get
Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
OnlyActivebooleanOptionalDefault:
falseOnlyArchivedbooleanOptionalDefault:
falseResponses
200
Success
application/json
pagesCountinteger · int32Optional
pageSizeinteger · int32Optional
currentPageinteger · int32Optional
totalItemsCountinteger · int32Optional
get/api/v1/features/refs
200
Success
get
Path parameters
indexinteger · int32Required
Responses
200
Success
application/json
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring · nullableOptional
namestring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
get/api/v1/features/{index}
200
Success
put
Path parameters
indexinteger · int32Required
Body
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring · nullableOptional
namestring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
Responses
200
Success
application/json
featureValuenumber · doubleOptional
idinteger · int32Optional
colorstring · nullableOptional
namestring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
isPublicbooleanOptional
upvotesCountinteger · int32Optional
commentsCountinteger · int32Optional
commentsTotalCountinteger · int32Optional
estimationinteger · int64Optional
put/api/v1/features/{index}
200
Success
delete
Path parameters
indexinteger · int32Required
Responses
200
Success
No content
400
Bad Request
application/json
404
Not Found
application/json
default
Error
application/json
delete/api/v1/features/{index}
No content
get
Path parameters
indexinteger · int32Required
Responses
200
Success
application/json
pagesCountinteger · int32Optional
pageSizeinteger · int32Optional
currentPageinteger · int32Optional
totalItemsCountinteger · int32Optional
404
Not Found
application/json
get/api/v1/features/{index}/comments
post
Path parameters
indexinteger · int32Required
Body
idstring · nullableOptional
contentstring · nullableOptional
isPublicbooleanOptional
sentViainteger · enumOptionalPossible values:
firstNamestring · nullableOptional
lastNamestring · nullableOptional
fullNamestring · nullableOptional
emailstring · nullableOptional
isThreadStarterbooleanOptional
threadStarterIdstring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
Responses
200
Success
application/json
idstring · nullableOptional
contentstring · nullableOptional
isPublicbooleanOptional
sentViainteger · enumOptionalPossible values:
firstNamestring · nullableOptional
lastNamestring · nullableOptional
fullNamestring · nullableOptional
emailstring · nullableOptional
isThreadStarterbooleanOptional
threadStarterIdstring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
404
Not Found
application/json
post/api/v1/features/{index}/comments
put
Path parameters
indexinteger · int32Required
commentIdstringRequired
Body
statebooleanOptional
Responses
200
Success
application/json
idstring · nullableOptional
contentstring · nullableOptional
isPublicbooleanOptional
sentViainteger · enumOptionalPossible values:
firstNamestring · nullableOptional
lastNamestring · nullableOptional
fullNamestring · nullableOptional
emailstring · nullableOptional
isThreadStarterbooleanOptional
threadStarterIdstring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
400
Bad Request
application/json
404
Not Found
application/json
default
Error
application/json
put/api/v1/features/{index}/comments/{commentId}/public
delete
Path parameters
indexinteger · int32Required
commentIdstringRequired
Responses
204
Success
application/json
idstring · nullableOptional
contentstring · nullableOptional
isPublicbooleanOptional
sentViainteger · enumOptionalPossible values:
firstNamestring · nullableOptional
lastNamestring · nullableOptional
fullNamestring · nullableOptional
emailstring · nullableOptional
isThreadStarterbooleanOptional
threadStarterIdstring · nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
400
Bad Request
application/json
404
Not Found
application/json
default
Error
application/json
delete/api/v1/features/{index}/comments/{commentId}
put
Body
idsinteger · int32[] · nullableOptional
modelany · nullableOptional
Responses
204
Success
No content
put/api/v1/features/batch/update
204
Success
No content
put
Body
idsinteger · int32[] · nullableOptional
modelany · nullableOptional
Responses
204
Success
No content
400
Bad Request
application/json
404
Not Found
application/json
default
Error
application/json
put/api/v1/features/batch/delete
No content
get
Responses
200
Success
application/json
idinteger · int32Optional
captionstring · nullableOptional
get/api/v1/features/priorities
200
Success
get
Responses
200
Success
application/json
idinteger · int32Optional
captionstring · nullableOptional
typeinteger · enumOptionalPossible values:
get/api/v1/features/statuses
200
Success
get
Responses
200
Success
application/json
idinteger · int32Optional
captionstring · nullableOptional
colorstring · nullableOptional
get/api/v1/features/types
200
Success
Last updated