Getting started

Attachments

Gets the requested artifact's information.

The version of the artifact that needs to be fetched.

Get Post

List the artifacts attached to an object.

List

The ID of the object to filter artifacts.

List Post

Locate

The ID of the artifact to get the URL for.

Locate Post

Creates an artifact and generates an upload URL for its data.

Prepare

artifacts

Identity provider

Creates a new enterprise authentication connection for a Dev
organization. This authentication connection will not be enabled by
default for the organization and the user will need to explicitly
enable this. Keep in mind that at a time, only one authentication
connection can be enabled for a Dev organization. At present, only 5
enterprise connections can be created by an organization.

Dev Org Auth Connections Create

Deletes an authentication connection. Only enterprise connections which
are explicitly set up for a Dev organization can be deleted. Default
connections can not be deleted using this method.

Dev Org Auth Connections Delete

Retrieves the details for an authentication connection.

Dev Org Auth Connections Get

Dev Org Auth Connections Get Post

Lists all the authentication connections available for a Dev
organization. This list will include both social and enterprise
connections which are either available by default or are explicitly
created by the user.

Dev Org Auth Connections List

Dev Org Auth Connections List Post

Enable or disable an authentication connection for a Dev organization.
Currently, only 1 authentication connection can be enabled at a time.
When a new authentication connection is enabled, the connection which
is currently enabled for the Dev organization is automatically
disabled.

Dev Org Auth Connections Toggle

Dev Org Auth Connections Update

auth-connection

Security tokens

Creates a JWT corresponding to the requested token type for the
authenticated user.

Create

Revokes the token that matches the given token ID issued under the
given Dev organization.

Delete

Gets the token metadata corresponding to the given token ID under the
given Dev organization.

The unique identifier of the token under a given Dev organization.

Gets the token metadata for all the tokens corresponding to the given
token type issued for a given subject.

An identifier that represents the application, which requested the
token. Only relevant for application access tokens.

The type of the requested token. If no value is specified, the
response will include tokens of all the types.

The subject associated with the token. In the absence of this
parameter, the ID of the authenticated entity is treated as the
subject.

Revokes all the tokens that matches the given token type created by the
authenticated user.

Self Delete

Updates token metadata of a token issued under a given Dev
organization.

Update

auth-tokens

Product builders and service providers

The cursor to resume iteration from. If not provided, then iteration
starts from the beginning.

Filters Dev users based on email addresses.

Unique ID of the user in the external source.

Issuer of the external identity of the user.

The maximum number of Dev users to return. The default is '50'.

The iteration mode to use, otherwise if not set, then "after" is
used.

Fields to sort the Dev users by and the direction to sort them.

Gets the authenticated user's information.

Self

Self Post

dev-users

Product components

Filters for parts created by any of these users.

The maximum number of parts to return. The default is '50'.

Filters for parts of the provided name(s).

Filters for parts owned by any of these users.

Number of levels to fetch the part hierarchy up to.

Filters for parts of the provided type(s).

parts

Workspaces

Creates a Rev organization in the authenticated user's Dev
organization.

Retrieves the Rev organization's information.

The ID of account for which default Rev organization is to be
fetched.

Gets the list of Rev organizations' information belonging to the
authenticated user's Dev Organization which the user is also authorized
to access.

Filters for objects created after the provided timestamp (inclusive).

Filters for objects created before the provided timestamp
(inclusive).

Array of display names of Rev orgs to be filtered.

List of external refs to filter Rev organizations for.

The maximum number of Rev organizations to be retrieved per page.

Fields to sort the Rev organizations by and the direction to sort
them.

Updates the Rev organization's information.

rev-orgs

Concepts

Creates a new tag, which is used to create associations between objects
and a logical concept denoted by the tag's name.

The maximum number of tags to return. The default is '50'.

Filters for tags with the provided names.

Fields to sort tags by and the direction to sort them.

Discussions and events

Creates a new entry on an object's timeline.

Deletes an entry from an object's timeline.

Lists the timeline entries for an object.

The ID of the object to list timeline entries for.

The visibility of the timeline entries to filter for. Note this is a
strict filter, such that only entries with the exact visibilities
specified will be returned.

Updates an entry on an object's timeline.

timeline-entries

Event responses

Gets the requested webhook's information.

webhooks

Tickets and issues

Export

Filters for work belonging to any of the provided parts.

Filters for work created by any of these users.

The number of work items to return. The default is '50', the maximum
is '5000'.

Filters for issues with any of the provided Accounts.

Filters for issues with any of the provided priorities.

Filters for issues with any of the provided priority enum ids.

Filters for issues with any of the provided Rev organizations.

Filters for work owned by any of these users.

Filters for work reported by any of these users.

Filters for records in the provided stage(s) by name.

Filters for works with selected sync statuses.

Filters for works modified with selected sync units.

Filters for issues synced from this specific origin system.

Filters for work with any of the provided tags.

Filters for tickets with any of the provided channels.

Filters for tickets belonging to specific groups.

Filters for tickets that are associated with any of the provided Rev
organizations.

Filters for tickets with any of the provided severities.

Filters for records with any of the provided SLA stages.

Filters for tickets with any of the provided source channels.

Export Post

The maximum number of works to return. The default is '50'.

works

Accounts

Creates an account, which is a record representing a customer or an
organization.

Filters for accounts created by the specified user(s).

Array of display names of accounts to be filtered.

Array of references of accounts to be filtered.

The number of accounts to return. The default is '50'.

Fields to sort the accounts by and the direction to sort them in.

Filters for accounts on specified stages.

The maximum number of accounts to return per page. The default is
'50'.

accounts

Management APIs for Service Level Agreements.

Service level agreement

Sla Trackers Get

Sla Trackers Get Post

slas

AccountsCreateResponse

AccountsDeleteResponse

The response to exporting a collection of accounts.

AccountsExportResponse

AccountsGetResponse

The response to listing all accounts matching the filter criteria.

AccountsListResponse

The cursor used to iterate subsequent results in accordance to the
sort order. If not set, then no later elements exist.

The cursor used to iterate preceding results in accordance to the
sort order. If not set, then no prior elements exist.

AccountsUpdateResponse

ArchetypeMetricTarget

If true, the schedule attached to this metric is out of schedule at
the time of the query.

Time in minutes that remains on a paused metric.

Time at which the metric would breach SLA if no action taken.

Time at which the metric would reach the SLA warning limit if no
action taken.

Artifact

ArtifactSummary

ArtifactVersion

The timestamp at which the version was created.

The response to getting an artifact's information.

ArtifactsGetResponse

The response to list artifacts attached to an object.

ArtifactsListResponse

The response to getting an artifact's download URL.

ArtifactsLocateResponse

The response to preparing a URL to upload a file.

ArtifactsPrepareResponse

The URL that the file's data should be uploaded to.

ArtifactsPrepareResponseFormData

AtomBase

Human-readable object ID unique to the Dev organization.

Timestamp when the object was last modified.

AtomBaseSummary

Connection object that specifies the configuration for an
authentication connection that is set up for a Dev organization.

AuthConnection

Whether the authentication connection is enabled or disabled. If
set to false, the authentication connection will not show up on the
login screen as a login option.

Object encapsulating the configuration parameters for an Azure AD
authentication connection.

AuthConnectionOptionsAzureAd

Client ID for the Azure authentication connection.

Client secret for the Azure authentication connection.

Domain URL of the Azure authentication connection.

Object encapsulating the configuration parameters for a Google Apps
authentication connection.

AuthConnectionOptionsGoogleApps

Client ID for the Google Apps authentication connection.

Client secret for the Google Apps authentication connection.

Tenant domain URL of the Google Apps authentication connection.

Object encapsulating the configuration parameters for an OIDC
authentication connection.

AuthConnectionOptionsOidc

Client ID for the OIDC authentication connection.

Client secret for the OIDC authentication connection.

Issuer URL of the OIDC authentication connection.

Object encapsulating the configuration parameters for a SAML
authentication connection.

AuthConnectionOptionsSaml

Sign In endpoint for the SAML authentication connection.

Signing certificate for the SAML authentication connection.

AuthConnectionOptionsSocial

AuthConnectionToggle

Defines the type for the authentication connection. The configuration
for each authentication connection will depend on the type value.

AuthConnectionType

AuthToken

An identifier that represents the application that requested the
token. Only applicable for application access tokens.

The scopes associated with the issued token.

Specifies the process of obtaining a token.

About

API Reference

Guides

SDKs

Snap-in development

Product components