Microsoft Azure DevOps

Microsoft Azure DevOps is a cloud-based service providing development collaboration tools, including source control, build pipelines, and release management.

Microsoft Azure DevOps is a comprehensive suite of development tools for planning, building, and deploying applications. This connector enables seamless integration with Swimlane Turbine, allowing users to automate work item management, streamline project tracking, and enhance collaboration. By leveraging Azure DevOps within Swimlane Turbine, users can efficiently manage work items, automate project workflows, and improve team productivity, all without writing a single line of code.

Prerequisites

Before you can use the Microsoft Azure DevOps connector for Turbine, you'll need access to the Azure DevOps API. This requires the following:

HTTP Basic authentication using the following parameters:

Username: Your Azure DevOps username.

Personal Access Token (PAT): A token generated in Azure DevOps for authentication.

URL: The base URL for your Azure DevOps organization.

Capabilities

This connector provides the following capabilities:

Delete User

Get Organizations List

Get User Entitlements

Get User

Get Users List

List PATs

Revoke PATs

Notes

Azure DevOps API Documentation

Configurations

HTTP Basic Authentication

Authenticates using username and PAT.

Configuration Parameters

Parameter	Description	Type	Required
url	URL	string	Required
username	Username	string	Required
password	Personal Access Token	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Add Work Item Comment

Add a plain text comment to a work item in Microsoft Azure DevOps using organization, project, workItemId, api-version, and text.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
text	string	Optional	The text of the comment.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123},"parameters":{"api-version":"7.2-preview.4"},"text":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
workItemId	number	Unique identifier
commentId	number	Unique identifier
version	number	Output field: version
text	string	Output field: text
renderedText	string	Output field: renderedText
format	string	Output field: format
isDeleted	boolean	Output field: isDeleted
url	string	URL endpoint for the request
createdDate	string	Date value
modifiedDate	string	Date value
createdBy	object	Output field: createdBy
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request
createdBy.imageUrl	string	URL endpoint for the request
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy._links	object	Output field: createdBy._links
modifiedBy	object	Output field: modifiedBy
modifiedBy.displayName	string	Name of the resource
modifiedBy.id	string	Unique identifier
modifiedBy.uniqueName	string	Name of the resource

Output Example

{"workItemId":123,"commentId":123,"version":123,"text":"string","renderedText":"string","format":"string","isDeleted":true,"url":"https://example.com/api/resource","createdDate":"string","modifiedDate":"string","createdBy":{"displayName":"Example Name","id":"12345678-1234-1234-1234-123456789abc","uniqueName":"Example Name","url":"https://example.com/api/resource","imageUrl":"string","descriptor":"string","_links":{}},"modifiedBy":{"displayName":"Example Name","id":"12345678-1234-1234-1234-123456...

Add Work Item Comment With Format

Add a formatted comment to a work item in Microsoft Azure DevOps. Requires organization, project, workItemId, api-version, and text.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.format	string	Optional	Format used for the comment text (Markdown or Html).
text	string	Optional	The text of the comment.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123},"parameters":{"api-version":"7.2-preview.4","format":"string"},"text":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
workItemId	number	Unique identifier
commentId	number	Unique identifier
version	number	Output field: version
text	string	Output field: text
renderedText	string	Output field: renderedText
format	string	Output field: format
isDeleted	boolean	Output field: isDeleted
url	string	URL endpoint for the request
createdDate	string	Date value
modifiedDate	string	Date value
createdBy	object	Output field: createdBy
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request
createdBy.imageUrl	string	URL endpoint for the request
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy._links	object	Output field: createdBy._links
modifiedBy	object	Output field: modifiedBy
modifiedBy.displayName	string	Name of the resource
modifiedBy.id	string	Unique identifier
modifiedBy.uniqueName	string	Name of the resource

Output Example

Create Field

Create a work item tracking field in Microsoft Azure DevOps using organization, project, and API version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/fields

Method: POST

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.
_links	object	Optional	Link references to related REST resources.
canSortBy	boolean	Optional	Indicates whether the field is sortable in server queries.
description	string	Optional	The description of the field.
isDeleted	boolean	Optional	Indicates whether this field is deleted.
isIdentity	boolean	Optional	Indicates whether this field is an identity field.
isLocked	boolean	Optional	Indicates whether this field is marked as locked for editing.
isPicklist	boolean	Optional	Indicates whether this instance is picklist.
isPicklistSuggested	boolean	Optional	Indicates whether this instance is a suggested picklist.
isQueryable	boolean	Optional	Indicates whether the field can be queried in the server.
name	string	Optional	The name of the field.
picklistId	string	Optional	If this field is picklist, the identifier of the picklist associated, otherwise null.
readOnly	boolean	Optional	Indicates whether the field is [read only].
referenceName	string	Optional	Name of the resource
supportedOperations	array	Optional	The supported operations on this field.
supportedOperations.name	string	Optional	Friendly name of the operation.
supportedOperations.referenceName	string	Optional	Reference name of the operation.
type	string	Optional	The type of the field.
url	string	Optional	REST URL for the resource.
usage	string	Optional	The usage of the field.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"json_body":{"_links":{},"canSortBy":false,"description":"Test field","isDeleted":false,"isIdentity":false,"isLocked":false,"isPicklist":false,"isPicklistSuggested":false,"isQueryable":false,"name":"Test Field","picklistId":"fb1c8e5c-9a3d-4e7b-9f0c-1a2b3c4d5e6f","readOnly":false,"referenceName":"TestField","supportedOperations":[{"name":"Test Field","referenceName":"TestField"}],"type":"string","url":"https://dev.azure.com/test_org/test_project/_apis/wit/fields/TestField","usage":"workItem"},"path_parameters":{"organization":"test_org","project":"test_project"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
_links	object	Output field: _links
canSortBy	boolean	Output field: canSortBy
description	string	Output field: description
isDeleted	boolean	Output field: isDeleted
isIdentity	boolean	Unique identifier
isLocked	boolean	Output field: isLocked
isPicklist	boolean	Output field: isPicklist
isPicklistSuggested	boolean	Output field: isPicklistSuggested
isQueryable	boolean	Output field: isQueryable
name	string	Name of the resource
picklistId	string	Unique identifier
readOnly	boolean	Output field: readOnly
referenceName	string	Name of the resource
supportedOperations	array	Output field: supportedOperations
supportedOperations.name	string	Name of the resource
supportedOperations.referenceName	string	Name of the resource

Output Example

{"status_code":201,"reason":"Created","json_body":{"_links":{},"canSortBy":false,"description":"Test field","isDeleted":false,"isIdentity":false,"isLocked":false,"isPicklist":false,"isPicklistSuggested":false,"isQueryable":false,"name":"Test Field","picklistId":"fb1c8e5c-9a3d-4e7b-9f0c-1a2b3c4d5e6f","readOnly":false,"referenceName":"TestField","supportedOperations":[{}]}}

Create Queries

Create work item tracking queries in Microsoft Azure DevOps using organization, project, and query path parameters along with the api-version parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queries/{{query}}

Method: POST

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Parameters for the Create Queries action
parameters.validateWiqlOnly	boolean	Optional	Parameters for the Create Queries action
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	The name of the Azure DevOps project.
path_parameters.query	string	Required	The ID of the query to create.
_links	object	Optional	Link references to related REST resources.
children	array	Optional	The child query items inside a query folder.
clauses	object	Optional	The clauses for a flat query.
clauses.logicalOperator	string	Optional	The logical operator for the clauses.
clauses.clauses	array	Optional	The clauses for the query.
clauses.clauses.field	object	Optional	The field for the clause.
clauses.clauses.field.referenceName	string	Optional	The reference name of the field.
clauses.clauses.field.name	string	Optional	The name of the field.
clauses.clauses.field.url	string	Optional	The URL of the field.
clauses.clauses.operator	object	Optional	The operator for the clause.
clauses.clauses.operator.referenceName	string	Optional	The reference name of the operator.
clauses.clauses.operator.name	string	Optional	The name of the operator.
clauses.clauses.value	string	Optional	The value for the clause.
clauses.clauses.isFieldValue	boolean	Optional	Whether the value is a field value.
columns	array	Optional	The columns for the query.
columns.referenceName	string	Optional	The reference name of the column.
columns.name	string	Optional	The name of the column.
columns.url	string	Optional	The URL of the column.
createdBy	object	Optional	The identity who created the query item.
createdBy.displayName	string	Optional	The display name of the identity.

Input Example

{"parameters":{"api-version":"7.2-preview.2","validateWiqlOnly":false},"path_parameters":{"organization":"fabrikam","project":"Fabrikam-Fiber-Git","query":"Shared Queries"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
_links	object	Output field: _links
children	array	Output field: children
children.file_name	string	Name of the resource
children.file	string	Output field: children.file
clauses	object	Output field: clauses
columns	array	Output field: columns
columns.file_name	string	Name of the resource
columns.file	string	Output field: columns.file
createdBy	object	Output field: createdBy
createdBy._links	object	Output field: createdBy._links
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy.directoryAlias	string	Output field: createdBy.directoryAlias
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.imageUrl	string	URL endpoint for the request
createdBy.inactive	string	Output field: createdBy.inactive
createdBy.isAadIdentity	string	Unique identifier
createdBy.isContainer	string	Output field: createdBy.isContainer
createdBy.isDeletedInOrigin	string	Output field: createdBy.isDeletedInOrigin
createdBy.name	string	Name of the resource
createdBy.profileUrl	string	URL endpoint for the request
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request

Output Example

{"_links":{},"children":[{"file_name":"Example Name","file":"string"}],"clauses":{},"columns":[{"file_name":"Example Name","file":"string"}],"createdBy":{"_links":{},"descriptor":"string","directoryAlias":"string","displayName":"Example Name","id":"12345678-1234-1234-1234-123456789abc","imageUrl":"string","inactive":"string","isAadIdentity":"string","isContainer":"string","isDeletedInOrigin":"string","name":"Example Name","profileUrl":"string","uniqueName":"Example Name","url":"https://example.c...

Create Work Item

Create a work item in Microsoft Azure DevOps using JSON Patch operations. Requires organization, project, and type as path parameters, and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitems/${{type}}

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.type	string	Required	The work item type of the work item to create
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.validateOnly	boolean	Optional	Indicate if you only want to validate the changes without saving the work item
parameters.bypassRules	boolean	Optional	Do not enforce the work item type rules on this update
parameters.suppressNotifications	boolean	Optional	Do not fire any notifications for this change
parameters.$expand	string	Optional	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

Input Example

{"path_parameters":{"organization":"string","project":"string","type":"string"},"parameters":{"api-version":"7.2-preview.3","validateOnly":true,"bypassRules":true,"suppressNotifications":true,"$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	number	Unique identifier
rev	number	Output field: rev
fields	object	Output field: fields
relations	array	Output field: relations
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"id":123,"rev":123,"fields":{},"relations":[],"url":"https://example.com/api/resource","_links":{}}

Create Work Item Attachment

Upload a work item attachment stream to Microsoft Azure DevOps WIT API. Requires organization, project, api-version, and file data.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/attachments

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.fileName	string	Optional	The name of the file
parameters.uploadType	string	Optional	Attachment upload type: Simple or Chunked
parameters.areaPath	string	Optional	Target project Area Path
file_data	array	Required	Binary file content for application or octet stream upload.
file_data.file_name	string	Required	Name of the file being uploaded.
file_data.file	string	Required	Binary file content sent as the request body.

Input Example

{"path_parameters":{"organization":"string","project":"string"},"parameters":{"api-version":"7.2-preview.4","fileName":"Example Name","uploadType":"string","areaPath":"string"},"file_data":[{"file_name":"Example Name","file":"string"}]}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	string	Unique identifier
url	string	URL endpoint for the request

Output Example

{"id":"12345678-1234-1234-1234-123456789abc","url":"https://example.com/api/resource"}

Delete Fields

Delete work item tracking fields in Microsoft Azure DevOps using organization, project, and field name or reference name. Requires API version.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/fields/{{fieldNameOrRefName}}

Method: DELETE

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.
path_parameters.fieldNameOrRefName	string	Required	Field simple name or reference name.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"path_parameters":{"organization":"org123","project":"new_test_project","fieldNameOrRefName":"TestField"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"reason":"OK","json_body":{}}

Delete Queries

Delete a query or folder in Microsoft Azure DevOps using organization, project, and query path parameters along with the api-version parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queries/{{query}}

Method: DELETE

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	Parameters for the Delete Queries action
path_parameters.project	string	Required	The name of the Azure DevOps project.
path_parameters.query	string	Required	The ID of the query to delete.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"path_parameters":{"organization":"org123","project":"project123","query":"TestQuery"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"reason":"OK","json_body":{}}

Delete User

Remove a specified user from an Azure DevOps organization using their userId. Requires organization, userId as path parameters and api-version as a parameter.

Endpoint

URL: https://vsaex.dev.azure.com/{{organization}}/_apis/userentitlements/{{userId}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the Delete User action
path_parameters.userId	string	Required	Parameters for the Delete User action
parameters.api-version	string	Required	Parameters for the Delete User action

Input Example

{"parameters":{"api-version":"7.1-preview.3"},"path_parameters":{"organization":"swimlane-test","userId":"ZTliNmE5M2MtNTYxMC03OWQyLTg4ZmMtNTJhZDE2ZTI2NmQw"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Expires":"-1","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%2209cd44b8-efd8-4435-ac5f-cbfc5411f9...","X-TFS-ProcessId":"c031a33a-df9e-4fe9-83dd-6d9bb2d000d4","Strict-Transport-Security":"max-age=31536000; includeSubDomains","ActivityId":"0e5a0902-6357-4e49-a012-4b020e217769","X-TF...

Delete Work Item

Delete or permanently destroy a work item in Microsoft Azure DevOps using organization, project, id, and api-version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitems/{{id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.id	number	Required	ID of the work item to be deleted
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.destroy	boolean	Optional	Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.

Input Example

{"path_parameters":{"organization":"string","project":"string","id":123},"parameters":{"api-version":"7.2-preview.3","destroy":true}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	number	Unique identifier
code	number	Output field: code
name	string	Name of the resource
project	string	Output field: project
url	string	URL endpoint for the request
resource	object	Output field: resource

Output Example

{"id":123,"code":123,"name":"Example Name","project":"string","url":"https://example.com/api/resource","resource":{}}

Delete Work Item Attachment

Delete a work item attachment in Microsoft Azure DevOps using organization, project, id, and api-version.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/attachments/{{id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.id	string	Required	Attachment ID
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.

Input Example

{"path_parameters":{"organization":"string","project":"string","id":"12345678-1234-1234-1234-123456789abc"},"parameters":{"api-version":"7.2-preview.4"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	string	Unique identifier
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"id":"12345678-1234-1234-1234-123456789abc","url":"https://example.com/api/resource","_links":{}}

Delete Work Item Comment

Remove a comment from a work item in Microsoft Azure DevOps using the WIT API. Requires organization, project, workItemId, and commentId as path parameters and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments/{{commentId}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item.
path_parameters.commentId	number	Required	Id of the comment to delete.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123,"commentId":123},"parameters":{"api-version":"7.2-preview.4"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
workItemId	number	Unique identifier
commentId	number	Unique identifier
version	number	Output field: version
text	string	Output field: text
renderedText	string	Output field: renderedText
format	string	Output field: format
isDeleted	boolean	Output field: isDeleted
url	string	URL endpoint for the request
createdDate	string	Date value
modifiedDate	string	Date value
createdBy	object	Output field: createdBy
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request
createdBy.imageUrl	string	URL endpoint for the request
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy._links	object	Output field: createdBy._links
modifiedBy	object	Output field: modifiedBy
modifiedBy.displayName	string	Name of the resource
modifiedBy.id	string	Unique identifier
modifiedBy.uniqueName	string	Name of the resource

Output Example

Delete Work Items

Delete multiple work items in Microsoft Azure DevOps using organization, project, API version, and item IDs.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemsdelete

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.
ids	array	Optional	The requested work item ids
destroy	boolean	Optional	Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
skipNotifications	boolean	Optional	Optional parameter, if set to true, notifications will be disabled.

Input Example

{"path_parameters":{"organization":"string","project":"string"},"parameters":{"api-version":"7.2-preview.1"},"ids":[123],"destroy":true,"skipNotifications":true}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
count	number	Count value
value	array	Value for the parameter

Output Example

{"count":123,"value":[]}

Get Fields

Retrieve work item tracking fields in Microsoft Azure DevOps using organization, project, field name or reference name, and API version.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/fields/{{fieldNameOrRefName}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.
path_parameters.fieldNameOrRefName	string	Required	Field simple name or reference name.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"path_parameters":{"organization":"org123","project":"new_test_project","fieldNameOrRefName":"TestField"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
_links	object	Output field: _links
canSortBy	boolean	Output field: canSortBy
description	string	Output field: description
isDeleted	boolean	Output field: isDeleted
isIdentity	boolean	Unique identifier
isLocked	boolean	Output field: isLocked
isPicklist	boolean	Output field: isPicklist
isPicklistSuggested	boolean	Output field: isPicklistSuggested
isQueryable	boolean	Output field: isQueryable
name	string	Name of the resource
picklistId	string	Unique identifier
readOnly	boolean	Output field: readOnly
referenceName	string	Name of the resource
supportedOperations	array	Output field: supportedOperations
supportedOperations.name	string	Name of the resource
supportedOperations.referenceName	string	Name of the resource
type	string	Type of the resource
url	string	URL endpoint for the request
usage	string	Output field: usage

Output Example

{"status_code":200,"reason":"OK","json_body":{"_links":{},"canSortBy":false,"description":"Test field for demonstration purposes","isDeleted":false,"isIdentity":false,"isLocked":false,"isPicklist":false,"isPicklistSuggested":false,"isQueryable":true,"name":"TestField","picklistId":"fb1c8e5c-9a3d-4e7b-9f0c-1a2b3c4d5e6f","readOnly":false,"referenceName":"TestField","supportedOperations":[{}],"type":"string"}}

Get Organizations List

Retrieve a list of organizations in Microsoft Azure DevOps using specified organization, API version, and contribution IDs.

Endpoint

URL: /{{organization}}/_apis/Contribution/HierarchyQuery

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the Get Organizations List action
parameters.api-version	string	Required	Parameters for the Get Organizations List action
contributionIds	array	Optional	Unique identifier
dataProviderContext	object	Optional	Response data
dataProviderContext.properties	object	Optional	Response data

Input Example

{"parameters":{"api-version":"7.1-preview.1"},"json_body":{"contributionIds":["ms.vss-features.my-organizations-data-provider"],"dataProviderContext":{"properties":{}}},"path_parameters":{"organization":"swimlane-test"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
dataProviderSharedData	object	Response data
dataProviderSharedData._featureFlags	object	Response data
dataProviderSharedData._featureFlags.VisualStudio.Services.AdminEngagement.OrganizationOverview.EditableOrganizationAvatar	boolean	Response data
dataProviders	object	Response data
dataProviders.ms.vss-web.component-data	object	Response data
dataProviders.ms.vss-web.shared-data	object	Response data
dataProviders.ms.vss-features.my-organizations-data-provider	object	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.organizations	array	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.organizations.id	string	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.organizations.name	string	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.organizations.url	string	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.organizations.avatarUrl	string	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.mostRecentlyAccessedHosts	array	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.createNewOrgUrl	string	Response data
dataProviders.ms.vss-features.my-organizations-data-provider.isUserAccountMappingRequired	boolean	Response data

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"582","Content-Type":"application/json; charset=utf-8; api-version=7.1-preview.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%22bbd6aa66-fe47-41db-8044-6920e694f3...","X-TFS-ProcessId":"183dff5b-2a...

Get Queries

Get work item tracking queries from Microsoft Azure DevOps using organization, project, query path parameters, and api-version parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queries/{{query}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
parameters.$depth	number	Optional	The depth of the query to get.
parameters.$expand	string	Optional	The fields to expand.
parameters.$includeDeleted	boolean	Optional	Whether to include deleted queries.
parameters.$useIsoDateFormat	boolean	Optional	Whether to use ISO date format.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	The name of the Azure DevOps project.
path_parameters.query	string	Required	The ID of the query to get.

Input Example

{"parameters":{"api-version":"7.2-preview.3","$depth":2,"$expand":"wiql","$includeDeleted":true,"$useIsoDateFormat":true},"path_parameters":{"organization":"org123","project":"project123","query":"TestQuery"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
_links	object	Output field: _links
children	array	Output field: children
children.file_name	string	Name of the resource
children.file	string	Output field: children.file
clauses	object	Output field: clauses
columns	array	Output field: columns
columns.file_name	string	Name of the resource
columns.file	string	Output field: columns.file
createdBy	object	Output field: createdBy
createdBy._links	object	Output field: createdBy._links
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy.directoryAlias	string	Output field: createdBy.directoryAlias
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.imageUrl	string	URL endpoint for the request
createdBy.inactive	string	Output field: createdBy.inactive
createdBy.isAadIdentity	string	Unique identifier
createdBy.isContainer	string	Output field: createdBy.isContainer
createdBy.isDeletedInOrigin	string	Output field: createdBy.isDeletedInOrigin
createdBy.name	string	Name of the resource
createdBy.profileUrl	string	URL endpoint for the request
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request

Output Example

{"status_code":200,"reason":"OK","json_body":{"_links":{},"children":[],"clauses":{},"columns":[],"createdBy":{"_links":{},"descriptor":"aad.OHVjN2E3NjYtNWJhNy03YjgxLTlhMmUtYWJjZGVmZ2hpams=","directoryAlias":"alice","displayName":"Alice Developer","id":"12345678-90ab-cdef-1234-567890abcdef","imageUrl":"https://dev.azure.com/test_org/_api/_common/GraphProfile/MemberAvatars/aad.OHVjN...","inactive":"false","isAadIdentity":"true","isContainer":"false","isDeletedInOrigin":"false","name":"Alice Devel...

Get Queries Batch

Get a batch of work item tracking queries in Microsoft Azure DevOps using organization, project, and API version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queriesbatch

Method: POST

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	The name of the Azure DevOps project.
$expand	string	Optional	The fields to expand.
errorPolicy	string	Optional	The policy to use when errors occur.
ids	array	Optional	The IDs of the queries to get.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"json_body":{"$expand":"all","errorPolicy":"fail","ids":["c6725763-d9ae-487e-bb42-00222e2f4d9f","c19eec2d-07a0-4c20-be57-3f7903792ca6","298f94fd-30ea-40f3-8d25-3202c9effa3a"]},"path_parameters":{"organization":"string","project":"project123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.id	string	Unique identifier
value.name	string	Name of the resource
value.path	string	Value for the parameter
value.createdBy	object	Value for the parameter
value.createdBy.displayName	string	Name of the resource
value.createdBy.url	string	URL endpoint for the request
value.createdBy._links	object	Value for the parameter
value.createdBy._links.avatar	object	Value for the parameter
value.createdBy._links.avatar.href	string	Value for the parameter
value.createdBy.id	string	Unique identifier
value.createdBy.uniqueName	string	Name of the resource
value.createdBy.imageUrl	string	URL endpoint for the request
value.createdBy.descriptor	string	Value for the parameter
value.createdDate	string	Value for the parameter
value.lastModifiedBy	object	Value for the parameter
value.lastModifiedBy.displayName	string	Name of the resource
value.lastModifiedBy.url	string	URL endpoint for the request
value.lastModifiedBy._links	object	Value for the parameter
value.lastModifiedBy._links.avatar	object	Value for the parameter
value.lastModifiedBy._links.avatar.href	string	Value for the parameter
value.lastModifiedBy.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"count":3,"value":[{},{},{}]}}

Get User

Fetch a specific user's details from Microsoft Azure DevOps using their descriptor and organization information. Requires organization, userDescriptor, and api-version parameters.

Endpoint

URL: https://vssps.dev.azure.com/{{organization}}/_apis/graph/users/{{userDescriptor}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the Get User action
path_parameters.userDescriptor	string	Required	Parameters for the Get User action
parameters.api-version	string	Required	Parameters for the Get User action

Input Example

{"parameters":{"api-version":"7.1-preview.1"},"path_parameters":{"organization":"swimlane-test","userDescriptor":"msa.ZTliNmE5M2MtNTYxMC03OWQyLTg4ZmMtNTJhZDE2ZTI2NmQw"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
subjectKind	string	Output field: subjectKind
domain	string	Output field: domain
principalName	string	Name of the resource
mailAddress	string	Output field: mailAddress
origin	string	Output field: origin
originId	string	Unique identifier
displayName	string	Name of the resource
_links	object	Output field: _links
_links.self	object	Output field: _links.self
_links.self.href	string	Output field: _links.self.href
_links.memberships	object	Output field: _links.memberships
_links.memberships.href	string	Output field: _links.memberships.href
_links.membershipState	object	Output field: _links.membershipState
_links.membershipState.href	string	Output field: _links.membershipState.href
_links.storageKey	object	Output field: _links.storageKey
_links.storageKey.href	string	Output field: _links.storageKey.href
_links.avatar	object	Output field: _links.avatar
_links.avatar.href	string	Output field: _links.avatar.href
url	string	URL endpoint for the request
descriptor	string	Output field: descriptor

Output Example

{"subjectKind":"string","domain":"string","principalName":"Example Name","mailAddress":"string","origin":"string","originId":"string","displayName":"Example Name","_links":{"self":{"href":"string"},"memberships":{"href":"string"},"membershipState":{"href":"string"},"storageKey":{"href":"string"},"avatar":{"href":"string"}},"url":"https://example.com/api/resource","descriptor":"string"}

Get User Entitlements

Retrieve entitlement information for a specified user in a Microsoft Azure DevOps organization, requiring organization ID, user ID, and API version.

Endpoint

URL: https://vsaex.dev.azure.com/{{organization}}/_apis/userentitlements/{{userId}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the Get User Entitlements action
path_parameters.userId	string	Required	Parameters for the Get User Entitlements action
parameters.api-version	string	Required	Parameters for the Get User Entitlements action

Input Example

{"parameters":{"api-version":"7.1-preview.3"},"path_parameters":{"organization":"swimlane-test","userId":"ZTliNmE5M2MtNTYxMC03OWQyLTg4ZmMtNTJhZDE2ZTI2NmQw"}}

Output

Parameter	Type	Description
id	string	Unique identifier
user	object	Output field: user
user.subjectKind	string	Output field: user.subjectKind
user.metaType	string	Type of the resource
user.domain	string	Output field: user.domain
user.principalName	string	Name of the resource
user.mailAddress	string	Output field: user.mailAddress
user.origin	string	Output field: user.origin
user.originId	string	Unique identifier
user.displayName	string	Name of the resource
user._links	object	Output field: user._links
user._links.self	object	Output field: user._links.self
user._links.self.href	string	Output field: user._links.self.href
user._links.memberships	object	Output field: user._links.memberships
user._links.memberships.href	string	Output field: user._links.memberships.href
user._links.membershipState	object	Output field: user._links.membershipState
user._links.membershipState.href	string	Output field: user._links.membershipState.href
user._links.storageKey	object	Output field: user._links.storageKey
user._links.storageKey.href	string	Output field: user._links.storageKey.href
user.url	string	URL endpoint for the request
user.descriptor	string	Output field: user.descriptor
accessLevel	object	Output field: accessLevel
accessLevel.licensingSource	string	Output field: accessLevel.licensingSource
accessLevel.accountLicenseType	string	Type of the resource
accessLevel.msdnLicenseType	string	Type of the resource

Output Example

{"id":"fe2f1bdb-9779-491a-a6f6-c6e9322cfb00","user":{"subjectKind":"user","metaType":"member","domain":"14c5367e-ee12-4c94-98b8-b52c1fe3cfb1","principalName":"[email protected]","mailAddress":"[email protected]","origin":"aad","originId":"00000000-0000-0000-0000-000000000000","displayName":"User 1","_links":{"self":{},"memberships":{},"membershipState":{},"storageKey":{}},"url":"https://vssps.dev.azure.com/fabrikam/_apis/graph/users/aad.wUGM3IDZ1UTZzczNtkTZm...","descriptor":"aad.wUGM3IDZ1UTZz...

Get Users List

Retrieve a list of all users within the specified organization in Microsoft Azure DevOps. Requires 'organization' as a path parameter and 'api-version' as a parameter.

Endpoint

URL: https://vssps.dev.azure.com/{{organization}}/_apis/graph/users

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the Get Users List action
parameters.api-version	string	Required	Parameters for the Get Users List action
parameters.continuationToken	string	Optional	Parameters for the Get Users List action
parameters.scopeDescriptor	string	Optional	Parameters for the Get Users List action
parameters.subjectTypes	array	Optional	Parameters for the Get Users List action

Input Example

{"path_parameters":{"organization":"swimlane-test"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.subjectKind	string	Value for the parameter
value.domain	string	Value for the parameter
value.principalName	string	Name of the resource
value.mailAddress	string	Value for the parameter
value.origin	string	Value for the parameter
value.originId	string	Unique identifier
value.displayName	string	Name of the resource
value._links	object	Value for the parameter
value._links.self	object	Value for the parameter
value._links.self.href	string	Value for the parameter
value._links.memberships	object	Value for the parameter
value._links.memberships.href	string	Value for the parameter
value._links.membershipState	object	Value for the parameter
value._links.membershipState.href	string	Value for the parameter
value._links.storageKey	object	Value for the parameter
value._links.storageKey.href	string	Value for the parameter
value._links.avatar	object	Value for the parameter
value._links.avatar.href	string	Value for the parameter
value.url	string	URL endpoint for the request
value.descriptor	string	Value for the parameter

Output Example

{"count":123,"value":[{"subjectKind":"string","domain":"string","principalName":"Example Name","mailAddress":"string","origin":"string","originId":"string","displayName":"Example Name","_links":{},"url":"https://example.com/api/resource","descriptor":"string"}]}

Get Work Item

Retrieve a work item from Microsoft Azure DevOps using its identifier and optional fields. Requires organization, project, id, and api-version as inputs.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitems/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.id	number	Required	The work item id
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.fields	string	Optional	Comma-separated list of requested fields
parameters.asOf	string	Optional	AsOf UTC date time string
parameters.$expand	string	Optional	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

Input Example

{"path_parameters":{"organization":"string","project":"string","id":123},"parameters":{"api-version":"7.2-preview.3","fields":"string","asOf":"string","$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	number	Unique identifier
rev	number	Output field: rev
fields	object	Output field: fields
relations	array	Output field: relations
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"id":123,"rev":123,"fields":{},"relations":[],"url":"https://example.com/api/resource","_links":{}}

Get Work Item Attachment

Download work item attachment content from Microsoft Azure DevOps using organization, project, id, and api-version as inputs.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/attachments/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.id	string	Required	Attachment ID
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.fileName	string	Optional	Name of the file
parameters.download	boolean	Optional	If set to true always download attachment

Input Example

{"path_parameters":{"organization":"string","project":"string","id":"12345678-1234-1234-1234-123456789abc"},"parameters":{"api-version":"7.2-preview.4","fileName":"Example Name","download":true}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
message	string	Response message
typeKey	string	Type of the resource
errorCode	number	Error message if any
eventId	number	Unique identifier

Output Example

{"message":"string","typeKey":"string","errorCode":123,"eventId":123}

Get Work Item Comment

Retrieve a specific work item comment from Microsoft Azure DevOps using organization, project, workItemId, and commentId as path parameters, along with the api-version parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments/{{commentId}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item to get the comment.
path_parameters.commentId	number	Required	Id of the comment to return.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.includeDeleted	boolean	Optional	Specify if the deleted comment should be retrieved.
parameters.$expand	string	Optional	Specifies the additional data retrieval options for work item comments.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123,"commentId":123},"parameters":{"api-version":"7.2-preview.4","includeDeleted":true,"$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
workItemId	number	Unique identifier
commentId	number	Unique identifier
version	number	Output field: version
text	string	Output field: text
renderedText	string	Output field: renderedText
format	string	Output field: format
isDeleted	boolean	Output field: isDeleted
url	string	URL endpoint for the request
createdDate	string	Date value
modifiedDate	string	Date value
createdBy	object	Output field: createdBy
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request
createdBy.imageUrl	string	URL endpoint for the request
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy._links	object	Output field: createdBy._links
modifiedBy	object	Output field: modifiedBy
modifiedBy.displayName	string	Name of the resource
modifiedBy.id	string	Unique identifier
modifiedBy.uniqueName	string	Name of the resource

Output Example

Get Work Item Comments

Retrieve a pageable list of comments for a specific work item in Microsoft Azure DevOps. Requires organization, project, workItemId as path parameters and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item to get comments for.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.$top	number	Optional	Max number of comments to return.
parameters.continuationToken	string	Optional	Used to query for the next page of comments.
parameters.includeDeleted	boolean	Optional	Specify if the deleted comments should be retrieved.
parameters.$expand	string	Optional	Specifies the additional data retrieval options for work item comments.
parameters.order	string	Optional	Order in which the comments should be returned.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123},"parameters":{"api-version":"7.2-preview.4","$top":123,"continuationToken":"string","includeDeleted":true,"$expand":"string","order":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
comments	array	Output field: comments
comments.workItemId	number	Unique identifier
comments.commentId	number	Unique identifier
comments.version	number	Output field: comments.version
comments.text	string	Output field: comments.text
comments.renderedText	string	Output field: comments.renderedText
comments.isDeleted	boolean	Output field: comments.isDeleted
comments.url	string	URL endpoint for the request
comments.createdDate	string	Date value
comments.createdBy	object	Output field: comments.createdBy
comments.createdBy.displayName	string	Name of the resource
comments.createdBy.id	string	Unique identifier
comments.createdBy.uniqueName	string	Name of the resource
comments.createdBy.url	string	URL endpoint for the request
count	number	Count value
totalCount	number	Count value
continuationToken	string	Output field: continuationToken
nextPage	string	Output field: nextPage
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"comments":[{"workItemId":123,"commentId":123,"version":123,"text":"string","renderedText":"string","isDeleted":true,"url":"https://example.com/api/resource","createdDate":"string","createdBy":{}}],"count":123,"totalCount":123,"continuationToken":"string","nextPage":"string","url":"https://example.com/api/resource","_links":{}}

Get Work Item Comments Batch

Retrieve comments for specified work items in Microsoft Azure DevOps using organization, project, workItemId, api-version, and ids as inputs.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item to get comments for.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.ids	string	Required	Comma-separated list of comment ids to return.
parameters.includeDeleted	boolean	Optional	Specify if the deleted comments should be retrieved.
parameters.$expand	string	Optional	Specifies the additional data retrieval options for work item comments.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123},"parameters":{"api-version":"7.2-preview.4","ids":"string","includeDeleted":true,"$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
comments	array	Output field: comments
comments.workItemId	number	Unique identifier
comments.commentId	number	Unique identifier
comments.version	number	Output field: comments.version
comments.text	string	Output field: comments.text
comments.renderedText	string	Output field: comments.renderedText
comments.isDeleted	boolean	Output field: comments.isDeleted
comments.url	string	URL endpoint for the request
comments.createdDate	string	Date value
comments.createdBy	object	Output field: comments.createdBy
comments.createdBy.displayName	string	Name of the resource
comments.createdBy.id	string	Unique identifier
comments.createdBy.uniqueName	string	Name of the resource
comments.createdBy.url	string	URL endpoint for the request
count	number	Count value
totalCount	number	Count value
continuationToken	string	Output field: continuationToken
nextPage	string	Output field: nextPage
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

Get Work Item Template

Retrieve a work item template for a specified type in Microsoft Azure DevOps. Requires organization, project, and type as path parameters and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitems/${{type}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.type	string	Required	The work item type name
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.fields	string	Optional	Comma-separated list of requested fields
parameters.asOf	string	Optional	AsOf UTC date time string
parameters.$expand	string	Optional	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

Input Example

{"path_parameters":{"organization":"string","project":"string","type":"string"},"parameters":{"api-version":"7.2-preview.3","fields":"string","asOf":"string","$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	number	Unique identifier
rev	number	Output field: rev
fields	object	Output field: fields
relations	array	Output field: relations
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"id":123,"rev":123,"fields":{},"relations":[],"url":"https://example.com/api/resource","_links":{}}

Get Work Item Type Field

Get a field definition for a work item type in Microsoft Azure DevOps using organization, project, type, field, and api-version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypes/{{type}}/fields/{{field}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.type	string	Required	Work item type.
path_parameters.field	string	Required	Field reference name of the work item field.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.$expand	string	Optional	Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.

Input Example

{"path_parameters":{"organization":"string","project":"string","type":"string","field":"string"},"parameters":{"api-version":"7.2-preview.3","$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
alwaysRequired	boolean	Output field: alwaysRequired
allowedValues	array	Value for the parameter
dependentFields	array	Output field: dependentFields
helpText	string	Output field: helpText
name	string	Name of the resource
referenceName	string	Name of the resource
type	string	Type of the resource
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"alwaysRequired":true,"allowedValues":["string"],"dependentFields":[],"helpText":"string","name":"Example Name","referenceName":"Example Name","type":"string","url":"https://example.com/api/resource","_links":{}}

Get Work Items Batch

Retrieve multiple work items in Microsoft Azure DevOps using a batch request. Requires organization, project, api-version, and ids.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemsbatch

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.
ids	array	Optional	The requested work item ids
fields	array	Optional	The requested fields
asOf	string	Optional	AsOf UTC date time string
$expand	string	Optional	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }
errorPolicy	string	Optional	The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.

Input Example

{"path_parameters":{"organization":"string","project":"string"},"parameters":{"api-version":"7.2-preview.1"},"ids":[123],"fields":["string"],"asOf":"string","$expand":"string","errorPolicy":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

[]

List Fields

Retrieve a list of work item tracking fields in Microsoft Azure DevOps using organization, project, and API version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/fields

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.$expand	string	Optional	Use ExtensionFields to include extension fields, otherwise exclude them.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.

Input Example

{"parameters":{"api-version":"7.2-preview.3","$expand":"extensionFields"},"path_parameters":{"organization":"org123","project":"new_test_project"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"reason":"OK","json_body":[{"_links":{},"canSortBy":false,"description":"Test field for demonstration purposes","isDeleted":false,"isIdentity":false,"isLocked":false,"isPicklist":false,"isPicklistSuggested":false,"isQueryable":true,"name":"TestField","picklistId":"fb1c8e5c-9a3d-4e7b-9f0c-1a2b3c4d5e6f","readOnly":false,"referenceName":"TestField","supportedOperations":[],"type":"string"}]}

List PATs

Retrieve a list of Personal Access Tokens (PATs) for a specified user within a Microsoft Azure DevOps organization. Requires organization, user descriptor, and API version.

Endpoint

URL: https://vssps.dev.azure.com/{{organization}}/_apis/tokenadmin/personalaccesstokens/{{userDescriptor}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the List PATs action
path_parameters.userDescriptor	string	Required	Parameters for the List PATs action
parameters.api-version	string	Required	Parameters for the List PATs action
parameters.continuationToken	string	Optional	Parameters for the List PATs action
parameters.isPublic	boolean	Optional	Parameters for the List PATs action
parameters.pageSize	number	Optional	Parameters for the List PATs action

Input Example

{"path_parameters":{"organization":"swimlane-test","userDescriptor":"msa.ZTliNmE5M2MtNTYxMC03OWQyLTg4ZmMtNTJhZDE2ZTI2NmQw"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
value	array	Value for the parameter
value.clientId	string	Unique identifier
value.accessId	string	Unique identifier
value.authorizationId	string	Unique identifier
value.hostAuthorizationId	string	Unique identifier
value.userId	string	Unique identifier
value.validFrom	string	Unique identifier
value.validTo	string	Unique identifier
value.displayName	string	Name of the resource
value.scope	string	Value for the parameter
value.targetAccounts	array	Value for the parameter
value.token	object	Value for the parameter
value.alternateToken	object	Value for the parameter
value.isValid	boolean	Unique identifier
value.isPublic	boolean	Value for the parameter
value.publicData	object	Response data
value.source	object	Value for the parameter
value.claims	object	Value for the parameter
continuationToken	object	Output field: continuationToken

Output Example

{"value":[{"clientId":"string","accessId":"string","authorizationId":"string","hostAuthorizationId":"string","userId":"string","validFrom":"string","validTo":"string","displayName":"Example Name","scope":"string","targetAccounts":[],"token":{},"alternateToken":{},"isValid":true,"isPublic":true,"publicData":{}}],"continuationToken":{}}

List Queries

Retrieve a list of work item tracking queries in Microsoft Azure DevOps using organization, project, and API version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queries

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
parameters.$depth	number	Optional	The depth of the queries to list.
parameters.$expand	string	Optional	The fields to expand.
parameters.$includeDeleted	boolean	Optional	Whether to include deleted queries.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	The name of the Azure DevOps project.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"path_parameters":{"organization":"org123","project":"project123","$depth":3,"$expand":"all","$includeDeleted":true}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"reason":"OK","json_body":[{"_links":{},"children":[],"clauses":{},"columns":[],"createdBy":{},"createdDate":"2014-03-18T17:18:36.06Z","filterOptions":[],"hasChildren":false,"id":"342f0f44-4069-46b1-a940-3d0468979ceb","isDeleted":false,"isFolder":false,"isInvalidSyntax":false,"isPublic":true,"lastExecutedBy":{},"lastExecutedDate":"2014-03-18T17:18:36.06Z"}]}

List Work Item Type Fields

List field definitions for a work item type in Microsoft Azure DevOps. Requires organization, project, and type as path parameters, and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypes/{{type}}/fields

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.type	string	Required	Work item type.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.$expand	string	Optional	Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.

Input Example

{"path_parameters":{"organization":"string","project":"string","type":"string"},"parameters":{"api-version":"7.2-preview.3","$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
count	number	Count value
value	array	Value for the parameter
value.alwaysRequired	boolean	Value for the parameter
value.allowedValues	array	Value for the parameter
value.helpText	string	Value for the parameter
value.name	string	Name of the resource
value.referenceName	string	Name of the resource
value.type	string	Type of the resource
value.url	string	URL endpoint for the request

Output Example

{"count":123,"value":[{"alwaysRequired":true,"allowedValues":[],"helpText":"string","name":"Example Name","referenceName":"Example Name","type":"string","url":"https://example.com/api/resource"}]}

List Work Items

Retrieve work items from Microsoft Azure DevOps using organization, project, API version, and comma-separated identifiers.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitems

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.ids	string	Required	The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
parameters.fields	string	Optional	Comma-separated list of requested fields
parameters.asOf	string	Optional	AsOf UTC date time string
parameters.$expand	string	Optional	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.
parameters.errorPolicy	string	Optional	The flag to control error policy in a bulk get work items request. Possible options are {Fail, Omit}.

Input Example

{"path_parameters":{"organization":"string","project":"string"},"parameters":{"api-version":"7.2-preview.3","ids":"string","fields":"string","asOf":"string","$expand":"string","errorPolicy":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
count	number	Count value
value	array	Value for the parameter
value.id	number	Unique identifier
value.rev	number	Value for the parameter
value.fields	object	Value for the parameter
value.relations	array	Value for the parameter
value.url	string	URL endpoint for the request

Output Example

{"count":123,"value":[{"id":123,"rev":123,"fields":{},"relations":[],"url":"https://example.com/api/resource"}]}

Revoke PATs

Revoke Personal Access Tokens in Microsoft Azure DevOps for a specified organization. Requires 'organization' as a path parameter and 'api-version' as a parameter.

Endpoint

URL: https://vssps.dev.azure.com/{{organization}}/_apis/tokenadmin/revocations

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	Parameters for the Revoke PATs action
parameters.api-version	string	Required	Parameters for the Revoke PATs action
parameters.isPublic	boolean	Optional	Parameters for the Revoke PATs action

Input Example

{"parameters":{"api-version":"7.1-preview.1","isPublic":false},"json_body":[{"authorizationId":"532c7fe6-74f8-408b-8051-4abb73dca491"}],"path_parameters":{"organization":"swimlane-test"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"response_text":"string"}

Search Queries

Search for work item tracking queries in Microsoft Azure DevOps using organization, project, and API version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queries

Method: GET

Input

Argument Name	Type	Required	Description
parameters.$api-version	string	Optional	Parameters for the Search Queries action
parameters.$filter	string	Optional	Parameters for the Search Queries action
parameters.$top	number	Optional	Parameters for the Search Queries action
parameters.$expand	string	Optional	Parameters for the Search Queries action
parameters.$includeDeleted	boolean	Optional	Parameters for the Search Queries action
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	The name of the Azure DevOps project.

Input Example

{"parameters":{"$api-version":"7.2-preview.3","$filter":"test","$top":3,"$expand":"all","$includeDeleted":true},"path_parameters":{"organization":"org123","project":"project123"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
hasMore	boolean	Output field: hasMore
value	array	Value for the parameter
value.id	string	Unique identifier
value.name	string	Name of the resource
value.path	string	Value for the parameter
value.createdBy	object	Value for the parameter
value.createdBy.displayName	string	Name of the resource
value.createdBy.url	string	URL endpoint for the request
value.createdBy._links	object	Value for the parameter
value.createdBy._links.avatar	object	Value for the parameter
value.createdBy._links.avatar.href	string	Value for the parameter
value.createdBy.id	string	Unique identifier
value.createdBy.uniqueName	string	Name of the resource
value.createdBy.imageUrl	string	URL endpoint for the request
value.createdBy.descriptor	string	Value for the parameter
value.createdDate	string	Value for the parameter
value.lastModifiedBy	object	Value for the parameter
value.lastModifiedBy.displayName	string	Name of the resource
value.lastModifiedBy.url	string	URL endpoint for the request
value.lastModifiedBy._links	object	Value for the parameter
value.lastModifiedBy._links.avatar	object	Value for the parameter
value.lastModifiedBy._links.avatar.href	string	Value for the parameter

Output Example

{"status_code":200,"reason":"OK","json_body":{"count":3,"hasMore":false,"value":[{},{},{}]}}

Send Mail

Send mail for selected or queried work items in Microsoft Azure DevOps using RESTful method. Requires organization, project, and API version as inputs.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/sendmail

Method: POST

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.
fields	array	Optional	The fields to be sent in the mail.
ids	array	Optional	The IDs of the work items to be sent in the mail.
persistenceId	string	Optional	The persistence ID of the work items to be sent in the mail.
projectId	string	Optional	The ID of the project to be sent in the mail.
sortFields	array	Optional	The fields to be sorted by.
tempQueryId	string	Optional	The ID of the temporary query to be sent in the mail.
wiql	string	Optional	The WiQL query to be sent in the mail.
format	number	Optional	Mail format. Use 1 to send work-item field tables (required for successful delivery in most organizations).
message	object	Optional	The message to be sent in the mail.
message.body	string	Required	The body of the message to be sent in the mail.
message.inReplyTo	string	Optional	The ID of the message to reply to.
message.messageId	string	Required	The ID of the message to be sent in the mail.
message.subject	string	Required	The subject of the message to be sent in the mail.
message.cc	object	Optional	The CC recipients of the message to be sent in the mail.
message.cc.emailAddresses	array	Optional	The email addresses of the CC recipients.
message.cc.tfIds	array	Optional	The TF IDs of the CC recipients.
message.cc.unresolvedEntityIds	array	Optional	The unresolved entity IDs of the CC recipients.
message.to	object	Required	The recipients of the message to be sent in the mail.
message.to.emailAddresses	array	Optional	The email addresses of the recipients.
message.to.tfIds	array	Optional	The TF IDs of the recipients.
message.to.unresolvedEntityIds	array	Optional	The unresolved entity IDs of the recipients.
message.replyTo	object	Optional	The recipients of the message to be sent in the mail.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"json_body":{"ids":[4],"projectId":"57d656d9-3caa-407d-b42d-22bc932a694b","persistenceId":"57d656d9-3caa-407d-b42d-22bc932a694b","tempQueryId":"cc4811e2-4d7c-4c6b-946f-497a0c4996b5","format":1,"fields":["System.Id","System.Title","System.State","System.WorkItemType","Microsoft.VSTS.Common.Severity","System.Tags"],"sortFields":["System.Id","System.Title"],"wiql":"SELECT [System.Id], [System.Title], [System.State], [System.WorkItemType], [Microsoft.VSTS.Common.Severity], [System.Tags] FROM WorkItems WHERE [System.TeamProject] = 'Dynamic Forms' AND [System.Id] = 4","message":{"messageId":"<[email protected]>","inReplyTo":"","subject":"Bug 4: Hello World","body":"<html><body><h2>Bug 4: Hello World</h2></body></html>","to":{"emailAddresses":["[email protected]"],"tfIds":["14b52061-7a90-4e31-a53c-4b802877c640"],"unresolvedEntityIds":[]},"cc":{"emailAddresses":["[email protected]"],"tfIds":["14b52061-7a90-4e31-a53c-4b802877c640"],"unresolvedEntityIds":[]},"replyTo":{"emailAddresses":["[email protected]"],"tfIds":["14b52061-7a90-4e31-a53c-4b802877c640"],"unresolvedEntityIds":[]}}},"path_parameters":{"organization":"placeholder","project":"placeholder"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}

Tags - Delete

Remove a tag from a project in Microsoft Azure DevOps, affecting all associated Work Items and Pull Requests. Requires organization, project, tagIdOrName, and api-version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/tags/{{tagIdOrName}}

Method: DELETE

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.
path_parameters.tagIdOrName	string	Required	Tag ID or tag name.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"string","project":"string","tagIdOrName":"Example Name"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"status_code":204,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Expires":"-1","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%22fa4d2f12-656b-4b5b-801b-569f7409af...","X-TFS-ProcessId":"cf939d1d-52e3-4354-a2d1-c20f8365e9d0","Strict-Transport-Security":"max-age=31536000; includeSubDomains","ActivityId":"8afde121-6efb-4a80-90f9-92e09d89603c","X-TF...

Tags - Get

Retrieve a specific tag for a project in Microsoft Azure DevOps using organization, project, and tagIdOrName as path parameters, along with the api-version parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/tags/{{tagIdOrName}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization. - organization
path_parameters.project	string	Required	Project ID or project name. - project
path_parameters.tagIdOrName	string	Required	Tag ID or tag name. - tagIdOrName

Input Example

{"path_parameters":{"organization":"organization","project":"project","tagIdOrName":"tagIdOrName"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
name	string	Name of the resource
url	string	URL endpoint for the request
lastUpdated	string	Output field: lastUpdated

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"303","Content-Type":"application/json; charset=utf-8; api-version=7.2-preview.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%223dc7bbb7-3c00-4c77-964e-524b86e20a...","X-TFS-ProcessId":"390c3a42-eb...

Tags - List

Retrieve all tags associated with a specific project in Microsoft Azure DevOps. Requires organization, project as path parameters and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/tags

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization. - organization
path_parameters.project	string	Required	Project ID or project name. - project

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"organization","project":"project"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.id	string	Unique identifier
value.name	string	Name of the resource
value.url	string	URL endpoint for the request
value.lastUpdated	string	Value for the parameter

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"503","Content-Type":"application/json; charset=utf-8; api-version=7.2-preview.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%221011f20e-cccf-47b3-bd62-12d15a5c87...","X-TFS-ProcessId":"299c29e8-ca...

Tags - Update

Update the tag for a project in Microsoft Azure DevOps using organization, project, tagIdOrName, api-version, and id.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/tags/{{tagIdOrName}}

Method: PATCH

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization. - organization
path_parameters.project	string	Required	Project ID or project name. - project
path_parameters.tagIdOrName	string	Required	Tag ID or tag name. - tagIdOrName
id	string	Optional	The ID of the tag.
lastUpdated	string	Optional	The date and time the tag was last updated.
name	string	Optional	The name of the tag.
url	string	Optional	The URL of the tag.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"json_body":{"id":"18090594-b371-4140-99d2-fc93bcbcddec","lastUpdated":"2022-11-01T10:56:26.433Z","name":"new-name","url":"http://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/tags/18090594-b371-4140-99d2-fc93bcbcddec?api-version=7.2-preview.1"},"path_parameters":{"organization":"organization","project":"project","tagIdOrName":"tagIdOrName"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
$id	string	Unique identifier
innerException	object	Output field: innerException
message	string	Response message
typeName	string	Name of the resource
typeKey	string	Type of the resource
errorCode	number	Error message if any
eventId	number	Unique identifier

Output Example

{"status_code":404,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"269","Content-Type":"application/json; charset=utf-8","Expires":"-1","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%22be90ff53-a434-4d15-b143-26504a9d9c...","X-TFS-ProcessId":"109c1843-683f-4c39-bad9-e42b29e1648c","Strict-Transport-Security":"max-age=31536000; incl...

Update Fields

Update work item tracking fields in Microsoft Azure DevOps using organization, project, field name or reference name, and API version.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/fields/{{fieldNameOrRefName}}

Method: PATCH

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name.
path_parameters.fieldNameOrRefName	string	Required	Name/reference name of the field to be updated.
isDeleted	boolean	Optional	Indicates whether the user wants to restore the field.
isLocked	boolean	Optional	Indicates whether the user wants to lock the field.

Input Example

{"parameters":{"api-version":"7.2-preview.3"},"json_body":{"isDeleted":false,"isLocked":false},"path_parameters":{"organization":"org123","project":"new_test_project","fieldNameOrRefName":"TestField"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

Update Queries

Update work item tracking queries in Microsoft Azure DevOps using organization, project, and query path parameters along with the required API version.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/queries/{{query}}

Method: PATCH

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
parameters.$undeleteDescendants	boolean	Optional	Whether to undelete descendants of the query.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	The name of the Azure DevOps project.
path_parameters.query	string	Required	The ID of the query to update.
_links	object	Optional	Link references to related REST resources.
children	array	Optional	The child query items inside a query folder.
clauses	object	Optional	The clauses for a flat query.
clauses.logicalOperator	string	Optional	The logical operator for the clauses.
clauses.clauses	array	Optional	The clauses for the query.
clauses.clauses.field	object	Optional	The field for the clause.
clauses.clauses.field.referenceName	string	Optional	The reference name of the field.
clauses.clauses.field.name	string	Optional	The name of the field.
clauses.clauses.field.url	string	Optional	The URL of the field.
clauses.clauses.operator	object	Optional	The operator for the clause.
clauses.clauses.operator.referenceName	string	Optional	The reference name of the operator.
clauses.clauses.operator.name	string	Optional	The name of the operator.
clauses.clauses.value	string	Optional	The value for the clause.
columns	array	Optional	The columns for the query.
columns.referenceName	string	Optional	The reference name of the column.
columns.name	string	Optional	The name of the column.
columns.url	string	Optional	The URL of the column.
createdBy	object	Optional	The identity who created the query item.
createdBy.displayName	string	Optional	The display name of the identity.
createdBy.url	string	Optional	The URL of the identity.

Input Example

{"parameters":{"api-version":"7.2-preview.3","$undeleteDescendants":true},"path_parameters":{"organization":"org123","project":"project123","query":"TestQuery"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
name	string	Name of the resource
path	string	Output field: path
createdDate	string	Date value
lastModifiedBy	object	Output field: lastModifiedBy
lastModifiedBy.displayName	string	Name of the resource
lastModifiedBy.url	string	URL endpoint for the request
lastModifiedBy._links	object	Link references to related REST resources.
lastModifiedBy.id	string	Unique identifier
lastModifiedBy.uniqueName	string	Name of the resource
lastModifiedBy.imageUrl	string	URL endpoint for the request
lastModifiedBy.descriptor	string	Output field: lastModifiedBy.descriptor
lastModifiedDate	string	Date value
queryType	string	Type of the resource
columns	array	Output field: columns
columns.referenceName	string	Name of the resource
columns.name	string	Name of the resource
columns.url	string	URL endpoint for the request
sortColumns	array	Output field: sortColumns
sortColumns.field	object	Output field: sortColumns.field
sortColumns.field.referenceName	string	Name of the resource
sortColumns.field.name	string	Name of the resource
sortColumns.field.url	string	URL endpoint for the request

Output Example

{"id":"12345678-1234-1234-1234-123456789abc","name":"Example Name","path":"string","createdDate":"string","lastModifiedBy":{"displayName":"Example Name","url":"https://example.com/api/resource","_links":{},"id":"12345678-1234-1234-1234-123456789abc","uniqueName":"Example Name","imageUrl":"string","descriptor":"string"},"lastModifiedDate":"string","queryType":"string","columns":[{"referenceName":"Example Name","name":"Example Name","url":"https://example.com/api/resource"}],"sortColumns":[{"field...

Update Work Item

Update a work item in Microsoft Azure DevOps using JSON Patch operations. Requires organization, project, ID as path parameters and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitems/{{id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.id	number	Required	The id of the work item to update
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.
parameters.validateOnly	boolean	Optional	Indicate if you only want to validate the changes without saving the work item
parameters.bypassRules	boolean	Optional	Do not enforce the work item type rules on this update
parameters.suppressNotifications	boolean	Optional	Do not fire any notifications for this change
parameters.$expand	string	Optional	The expand parameters for work item attributes. Possible options are { None, Relations, Fields, Links, All }.

Input Example

{"path_parameters":{"organization":"string","project":"string","id":123},"parameters":{"api-version":"7.2-preview.3","validateOnly":true,"bypassRules":true,"suppressNotifications":true,"$expand":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	number	Unique identifier
rev	number	Output field: rev
fields	object	Output field: fields
relations	array	Output field: relations
url	string	URL endpoint for the request
_links	object	Output field: _links

Output Example

{"id":123,"rev":123,"fields":{},"relations":[],"url":"https://example.com/api/resource","_links":{}}

Update Work Item Comment

Update the text of an existing work item comment in Microsoft Azure DevOps using organization, project, workItemId, commentId, api-version, and text.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments/{{commentId}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item.
path_parameters.commentId	number	Required	Id of the comment to update.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
text	string	Optional	The updated text of the comment.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123,"commentId":123},"parameters":{"api-version":"7.2-preview.4"},"text":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
workItemId	number	Unique identifier
commentId	number	Unique identifier
version	number	Output field: version
text	string	Output field: text
renderedText	string	Output field: renderedText
format	string	Output field: format
isDeleted	boolean	Output field: isDeleted
url	string	URL endpoint for the request
createdDate	string	Date value
modifiedDate	string	Date value
createdBy	object	Output field: createdBy
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request
createdBy.imageUrl	string	URL endpoint for the request
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy._links	object	Output field: createdBy._links
modifiedBy	object	Output field: modifiedBy
modifiedBy.displayName	string	Name of the resource
modifiedBy.id	string	Unique identifier
modifiedBy.uniqueName	string	Name of the resource

Output Example

Update Work Item Comment With Format

Update a work item comment in Microsoft Azure DevOps with optional format. Requires organization, project, workItemId, commentId, api-version, and text.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workItems/{{workItemId}}/comments/{{commentId}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.workItemId	number	Required	Id of a work item.
path_parameters.commentId	number	Required	Id of the comment to update.
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.format	string	Optional	Format used for the comment text (Markdown or Html).
text	string	Optional	The updated text of the comment.

Input Example

{"path_parameters":{"organization":"string","project":"string","workItemId":123,"commentId":123},"parameters":{"api-version":"7.2-preview.4","format":"string"},"text":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
workItemId	number	Unique identifier
commentId	number	Unique identifier
version	number	Output field: version
text	string	Output field: text
renderedText	string	Output field: renderedText
format	string	Output field: format
isDeleted	boolean	Output field: isDeleted
url	string	URL endpoint for the request
createdDate	string	Date value
modifiedDate	string	Date value
createdBy	object	Output field: createdBy
createdBy.displayName	string	Name of the resource
createdBy.id	string	Unique identifier
createdBy.uniqueName	string	Name of the resource
createdBy.url	string	URL endpoint for the request
createdBy.imageUrl	string	URL endpoint for the request
createdBy.descriptor	string	Output field: createdBy.descriptor
createdBy._links	object	Output field: createdBy._links
modifiedBy	object	Output field: modifiedBy
modifiedBy.displayName	string	Name of the resource
modifiedBy.id	string	Unique identifier
modifiedBy.uniqueName	string	Name of the resource

Output Example

Upload Work Item Attachment Chunk

Upload a chunked attachment byte range to Microsoft Azure DevOps Work Item Tracking. Requires organization, project, id, api-version, headers, and file data.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/attachments/{{id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.project	string	Required	Project ID or project name
path_parameters.id	string	Required	The id of the attachment
parameters.api-version	string	Required	Version of the API to use. This should be set to '7.2-preview.4' to use this version of the api.
parameters.fileName	string	Optional	Name to associate with the uploaded attachment file.
headers	object	Required	Request headers for the chunked octet-stream upload.
headers.Content-Range	string	Required	Starting and ending byte positions for chunked upload, format is "bytes 0-10000/50000".
file_data	array	Required	Binary chunk content matching the Content-Range header span.
file_data.file_name	string	Required	Name of the file being uploaded.
file_data.file	string	Required	Binary file content sent as the request body.

Input Example

{"path_parameters":{"organization":"string","project":"string","id":"12345678-1234-1234-1234-123456789abc"},"parameters":{"api-version":"7.2-preview.4","fileName":"Example Name"},"headers":{"Content-Range":"string"},"file_data":[{"file_name":"Example Name","file":"string"}]}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text
id	string	Unique identifier
url	string	URL endpoint for the request

Output Example

{"id":"12345678-1234-1234-1234-123456789abc","url":"https://example.com/api/resource"}

Work Item Relation Types - Get

Retrieve the work item relation type definition in Microsoft Azure DevOps using organization, relation, and api-version parameters.

Endpoint

URL: /{{organization}}/_apis/wit/workitemrelationtypes/{{relation}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.
path_parameters.relation	string	Required	The name of the relation.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"organization","relation":"relation name"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
attributes	object	Output field: attributes
attributes.usage	string	Output field: attributes.usage
attributes.editable	boolean	Output field: attributes.editable
attributes.enabled	boolean	Output field: attributes.enabled
referenceName	string	Name of the resource
name	string	Name of the resource
url	string	URL endpoint for the request

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"277","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%225d81a649-660e-4cb8-b498-ba25b5c05f...","X-TFS-ProcessId":"4fb5b612-f95b-4910-8e...

Work Item Relation Types - List

Retrieve the list of work item relation types in Microsoft Azure DevOps. Requires organization as a path parameter and api-version as a parameter.

Endpoint

URL: /{{organization}}/_apis/wit/workitemrelationtypes

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"organization"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.attributes	object	Value for the parameter
value.attributes.usage	string	Value for the parameter
value.attributes.editable	boolean	Value for the parameter
value.attributes.enabled	boolean	Value for the parameter
value.referenceName	string	Name of the resource
value.name	string	Name of the resource
value.url	string	URL endpoint for the request

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"928","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%2269ebc232-2d23-4d06-a9f7-2a6454114d...","X-TFS-ProcessId":"cf939d1d-52e3-4354-a2...

Work Item Transitions - List

Retrieve the next state transitions for specified work item IDs in Microsoft Azure DevOps. Requires organization as a path parameter and api-version, ids as parameters.

Endpoint

URL: /{{organization}}/_apis/wit/workitemtransitions

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	Version of the API to use.
parameters.ids	string	Required	The comma-separated list of requested work item ids.
parameters.action	string	Optional	The possible action to take on the work item.
path_parameters.organization	string	Required	The name of the Azure DevOps organization.

Input Example

{"parameters":{"api-version":"7.2-preview.1","ids":"1,2,3","action":"possible action"},"path_parameters":{"organization":"organization"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.id	number	Unique identifier
value.stateOnTransition	string	Value for the parameter

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"180","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%220e138120-c072-4510-946f-3421584835...","X-TFS-ProcessId":"8e083107-e207-4e8d-b7...

Work Item Type Categories - Get

Retrieve a specific work item type category by name in Microsoft Azure DevOps using organization, project, category, and api-version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypecategories/{{category}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	The name of the organization.
path_parameters.project	string	Required	The name of the project.
path_parameters.category	string	Required	The name of the category.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"org123","project":"new_test_project","category":"new_test_category"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
name	string	Name of the resource
referenceName	string	Name of the resource
defaultWorkItemType	object	Type of the resource
defaultWorkItemType.name	string	Name of the resource
defaultWorkItemType.url	string	URL endpoint for the request
workItemTypes	array	Type of the resource
workItemTypes.name	string	Name of the resource
workItemTypes.url	string	URL endpoint for the request
url	string	URL endpoint for the request

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"316","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%2204882a9f-7200-4e6f-9b70-2c99087a9e...","X-TFS-ProcessId":"7bddeffe-d11a-4a4a-b3...

Retrieve all work item type categories in Microsoft Azure DevOps for a specified organization and project. Requires api-version, organization, and project as inputs.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypecategories

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	The name of the organization.
path_parameters.project	string	Required	The name of the project.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"org123","project":"new_test_project"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.name	string	Name of the resource
value.referenceName	string	Name of the resource
value.defaultWorkItemType	object	Type of the resource
value.defaultWorkItemType.name	string	Name of the resource
value.defaultWorkItemType.url	string	URL endpoint for the request
value.workItemTypes	array	Type of the resource
value.workItemTypes.name	string	Name of the resource
value.workItemTypes.url	string	URL endpoint for the request
value.url	string	URL endpoint for the request

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"1129","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%22a60d3407-187d-4ed6-89b6-7117c95ee9...","X-TFS-ProcessId":"2cb317b1-731c-4805-8...

Work Item Type States - List

Retrieve state names and colors for a specified work item type in Microsoft Azure DevOps. Requires organization, project, type as path parameters, and api-version as a parameter.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypes/{{type}}/states

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	The name of the organization.
path_parameters.project	string	Required	The name of the project.
path_parameters.type	string	Required	The name of the work item type.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"org123","project":"new_test_project","type":"new_test_type"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.name	string	Name of the resource
value.color	string	Value for the parameter
value.category	string	Value for the parameter

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Content-Length":"263","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%22390d5040-187c-4b35-a34d-8fdd1e91a8...","X-TFS-ProcessId":"389eab22-1963-4187-9c...

Work Item Types - Get

Retrieve a work item type definition in Microsoft Azure DevOps using organization, project, type, and api-version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypes/{{type}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	The name of the organization.
path_parameters.project	string	Required	The name of the project.
path_parameters.type	string	Required	The name of the work item type.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"org123","project":"new_test_project","type":"new_test_type"}}

Output

Parameter	Type	Description
name	string	The name of the work item type.
referenceName	string	The reference name of the work item type.
description	string	The description of the work item type.
color	string	The color of the work item type.
icon	object	The icon of the work item type.
icon.id	string	The ID of the icon.
icon.url	string	The URL of the icon.
isDisabled	boolean	Whether the work item type is disabled.
xmlForm	string	The XML form of the work item type.
fields	array	The fields of the work item type.
fields.helpText	string	The help text for the field.
fields.alwaysRequired	boolean	Whether the field is always required.
fields.referenceName	string	The reference name of the field.
fields.name	string	The name of the field.
fields.url	string	The URL of the field.
fieldInstances	array	The field instances of the work item type.
fieldInstances.helpText	string	The help text for the field.
fieldInstances.alwaysRequired	boolean	Whether the field is always required.
fieldInstances.referenceName	string	The reference name of the field.
fieldInstances.name	string	The name of the field.
fieldInstances.url	string	The URL of the field.
states	array	The states of the work item type.
states.name	string	The name of the state.
states.color	string	The color of the state.
states.category	string	The category of the state.

Output Example

{"name":"Bug","referenceName":"Microsoft.VSTS.WorkItemTypes.Bug","description":"Describes a divergence between required and actual behavior, and tracks the work...","color":"CC293D","icon":{"id":"icon_insect","url":"https://dev.azure.com/fabrikam/_apis/wit/workItemIcons/icon_insect?color=CC293D&..."},"isDisabled":false,"xmlForm":"<FORM><Layout HideReadOnlyEmptyFields=\"true\" HideControlBorders=\"true\"><Group Ma...","fields":[{"helpText":"The iteration within which this bug will be fixed","alwa...

Work Item Types - List

Retrieve a list of work item types in Microsoft Azure DevOps for a specified organization and project. Requires organization, project, and api-version parameters.

Endpoint

URL: /{{organization}}/{{project}}/_apis/wit/workitemtypes

Method: GET

Input

Argument Name	Type	Required	Description
parameters.api-version	string	Required	The version of the API to use.
path_parameters.organization	string	Required	The name of the organization.
path_parameters.project	string	Required	The name of the project.

Input Example

{"parameters":{"api-version":"7.2-preview.1"},"path_parameters":{"organization":"org123","project":"new_test_project"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
count	number	Count value
value	array	Value for the parameter
value.name	string	Name of the resource
value.referenceName	string	Name of the resource
value.description	string	Value for the parameter
value.color	string	Value for the parameter
value.icon	object	Value for the parameter
value.icon.id	string	Unique identifier
value.icon.url	string	URL endpoint for the request
value.isDisabled	boolean	Value for the parameter
value.xmlForm	string	Value for the parameter
value.fields	array	Value for the parameter
value.fields.defaultValue	object	Value for the parameter
value.fields.helpText	string	Value for the parameter
value.fields.alwaysRequired	boolean	Value for the parameter
value.fields.referenceName	string	Name of the resource
value.fields.name	string	Name of the resource
value.fields.url	string	URL endpoint for the request
value.fieldInstances	array	Value for the parameter
value.fieldInstances.defaultValue	object	Value for the parameter
value.fieldInstances.helpText	string	Value for the parameter
value.fieldInstances.alwaysRequired	boolean	Value for the parameter
value.fieldInstances.referenceName	string	Name of the resource

Output Example

{"status_code":200,"response_headers":{"Cache-Control":"no-cache, no-store, must-revalidate","Pragma":"no-cache","Transfer-Encoding":"chunked","Content-Type":"application/json; charset=utf-8; api-version=7.1","Content-Encoding":"gzip","Expires":"-1","Vary":"Accept-Encoding","P3P":"CP=\"CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA...","Set-Cookie":"VstsSession=%7B%22PersistentSessionId%22%3A%2248f4a39f-aa46-42f2-a81e-1b950e3a0b...","X-TFS-ProcessId":"109c1843-683f-...

Response Headers

Header	Description	Example
Access-Control-Expose-Headers	HTTP response header: Access-Control-Expose-Headers	Request-Context
ActivityId	HTTP response header: ActivityId	8a9a7d78-6efb-4a80-90f9-92e09d89603c
Cache-Control	Directives for caching mechanisms	no-cache, no-store, must-revalidate
Content-Disposition	HTTP response header: Content-Disposition	attachment; filename=image.png
Content-Encoding	HTTP response header: Content-Encoding	gzip
Content-Length	The length of the response body in bytes	256
Content-Type	The media type of the resource	application/json; charset=utf-8; api-version=7.1
Date	The date and time at which the message was originated	Thu, 21 May 2026 07:44:48 GMT
Expires	The date/time after which the response is considered stale	-1
P3P	HTTP response header: P3P	CP="CAO DSP COR ADMa DEV CONo TELo CUR PSA PSD TAI IVDo OUR SAMi BUS DEM NAV STA UNI COM INT PHY ONL FIN PUR LOC CNT"
Pragma	HTTP response header: Pragma	no-cache
Request-Context	HTTP response header: Request-Context	appId=cid-v1:ba8cca98-f9cc-4f08-a334-706ff8d04ac6
Set-Cookie	HTTP response header: Set-Cookie	VstsSession=%7B%22PersistentSessionId%22%3A%223dc7bbb7-3c00-4c77-964e-524b86e20a54%22%2C%22PendingAuthenticationSessionId%22%3A%2200000000-0000-0000-0000-000000000000%22%2C%22CurrentAuthenticationSessionId%22%3A%2200000000-0000-0000-0000-000000000000%22%2C%22SignInState%22%3A%7B%7D%7D;SameSite=None; domain=.dev.azure.com; expires=Fri, 21-May-2027 05:18:32 GMT; path=/; secure; HttpOnly
Strict-Transport-Security	HTTP response header: Strict-Transport-Security	max-age=31536000; includeSubDomains
Transfer-Encoding	HTTP response header: Transfer-Encoding	chunked
Vary	HTTP response header: Vary	Accept-Encoding
X-Cache	HTTP response header: X-Cache	CONFIG_NOCACHE
X-Content-Type-Options	HTTP response header: X-Content-Type-Options	nosniff
X-FRAME-OPTIONS	HTTP response header: X-FRAME-OPTIONS	SAMEORIGIN
X-MSEdge-Ref	HTTP response header: X-MSEdge-Ref	Ref A: 6BD84FDBF1E24535829E209D801DDC16 Ref B: BOM01EDGE0911 Ref C: 2026-05-20T17:08:12Z
X-RateLimit-Limit	The number of requests allowed in the current rate limit window	-1
X-RateLimit-Remaining	The number of requests remaining in the current rate limit window	0
X-RateLimit-Reset	The time at which the current rate limit window resets	1779341376
X-RateLimit-Resource	HTTP response header: X-RateLimit-Resource	TFS/Concurrent
X-TFS-ProcessId	HTTP response header: X-TFS-ProcessId	cf939d1d-52e3-4354-a2d1-c20f8365e9d0
X-TFS-Session	HTTP response header: X-TFS-Session	b2440f85-1504-4328-937c-1584232b7d6a
X-VSS-E2EID	HTTP response header: X-VSS-E2EID	2cedf4fe-eb93-4480-ac8c-9d883765544c
X-VSS-SenderDeploymentId	HTTP response header: X-VSS-SenderDeploymentId	0444d719-954b-4970-8216-09ea10adddc8
X-VSS-UserData	HTTP response header: X-VSS-UserData	14b52061-7a90-4e31-a53c-4b802877c640:sarath[email protected]