Easily Integrate
Atlassian's Jira API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 532 SDK methods
No Parameters
Response
Announcement banner configuration.
Error messages from an operation.
Error messages from an operation.
Endpoint
Parameter
Response
Error messages from an operation.
Error messages from an operation.
Error messages from an operation.
Endpoint
Parameter
Whether to generate a changelog for this update.
Response
Returned if the request is invalid.
Returned if the request is not authenticated as the app that provided all the fields.
Returned if any field is not found.
Endpoint
Parameter
The ID or key of the custom field, for example customfield_10000
.
The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001
. Can't be provided with fieldContextId
, issueId
, projectKeyOrId
, or issueTypeId
.
The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001
. Can't be provided with id
, issueId
, projectKeyOrId
, or issueTypeId
.
The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId
, or issueTypeId
.
The ID or key of the project to filter results by. Must be provided with issueTypeId
. Can't be provided with issueId
.
The ID of the issue type to filter results by. Must be provided with projectKeyOrId
. Can't be provided with issueId
.
The index of the first item to return in a page of results (page offset).
The maximum number of items to return per page.
Response
A page of items.
Returned if the request is invalid.
Returned if the authentication credentials are incorrect or missing.
Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field.
Returned if the custom field is not found.
Endpoint
Parameter
The ID or key of the custom field, for example customfield_10000
.
Response
Returned if the request is invalid.
Returned if the authentication credentials are incorrect or missing.
Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field.
Returned if the custom field is not found.
Endpoint
Parameter
The ID or key of the custom field. For example, customfield_10010
.
Whether to generate a changelog for this update.
Response
Returned if the request is invalid.
Returned if the request is not authenticated as the app that provided the field.
Returned if the field is not found.
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About Atlassian
We're a team of 7000+ Atlassians supporting an international group of 250,000+ customers. We build tools like Jira, Confluence, Bitbucket, and Trello to help teams across the world become more nimble, creative, and aligned.