Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v1

v1.3.0

May 8, 2026

v1.2.0

May 2, 2026

Changes in this version

type Client

+ func (c *Client) GetConfiguration(ctx context.Context) (*Configuration, error)

+ func (c *Client) GetEditMeta(ctx context.Context, issueKey string) (*EditMeta, error)

+ func (c *Client) GetFieldContexts(ctx context.Context, fieldID string, opts FieldContextOptions) (*FieldContextPage, error)

+ func (c *Client) GetFieldOptions(ctx context.Context, fieldID string, contextID string, onlyOptions bool, ...) (*FieldOptionPage, error)

+ func (c *Client) GetProjectStatuses(ctx context.Context, projectKey string) ([]ProjectIssueTypeStatuses, error)

+ func (c *Client) GetResolutions(ctx context.Context) ([]Resolution, error)

+ func (c *Client) GetServerInfo(ctx context.Context) (*ServerInfo, error)

+ func (c *Client) SearchFields(ctx context.Context, opts FieldSearchOptions) (*FieldSearchPage, error)

+ type Configuration struct

+ AttachmentsEnabled bool

+ IssueLinkingEnabled bool

+ SubTasksEnabled bool

+ TimeTracking TimeTrackingConfiguration

+ TimeTrackingEnabled bool

+ UnassignedIssuesAllowed bool

+ VotingEnabled bool

+ WatchingEnabled bool

+ type EditMeta struct

+ Fields map[string]EditMetaField

+ type EditMetaAllowedValue struct

+ Description string

+ ID string

+ Name string

+ Value string

+ type EditMetaField struct

+ AllowedValues []EditMetaAllowedValue

+ Name string

+ Required bool

+ Schema map[string]interface{}

+ type FieldContext struct

+ Description string

+ ID string

+ IsAnyIssueType bool

+ IsGlobalContext bool

+ Name string

+ type FieldContextOptions struct

+ ContextIDs []int

+ IsAnyIssueType *bool

+ IsGlobalContext *bool

+ MaxResults int

+ StartAt int

+ type FieldContextPage struct

+ IsLast bool

+ MaxResults int

+ StartAt int

+ Total int

+ Values []FieldContext

+ type FieldOption struct

+ ContextID string

+ Disabled bool

+ ID string

+ Value string

+ type FieldOptionPage struct

+ IsLast bool

+ MaxResults int

+ StartAt int

+ Total int

+ Values []FieldOption

+ type FieldSearchOptions struct

+ Expand string

+ IDs []string

+ MaxResults int

+ OrderBy string

+ ProjectIDs []int

+ Query string

+ StartAt int

+ Type string

+ type FieldSearchPage struct

+ IsLast bool

+ MaxResults int

+ StartAt int

+ Total int

+ Values []FieldSearchResult

+ type FieldSearchResult struct

+ ContextsCount int

+ Custom bool

+ Description string

+ ID string

+ IsLocked bool

+ Key string

+ Name string

+ Navigable bool

+ Orderable bool

+ ProjectsCount int

+ Schema json.RawMessage

+ ScreensCount int

+ Searchable bool

+ SearcherKey string

+ type ProjectIssueTypeStatuses struct

+ ID string

+ Name string

+ Statuses []Status

+ Subtask bool

+ type Resolution struct

+ Description string

+ ID string

+ Name string

+ type ServerInfo struct

+ BaseURL string

+ BuildDate string

+ BuildNumber int

+ DeploymentType string

+ ScmInfo string

+ ServerTime string

+ ServerTitle string

+ Version string

+ type StatusCategory struct

+ ID int

+ Key string

+ Name string

+ type TimeTrackingConfiguration struct

+ DefaultUnit string

+ TimeFormat string

+ WorkingDaysPerWeek float64

+ WorkingHoursPerDay float64

v1.1.0

May 2, 2026

v1.0.0

May 2, 2026

Changes in this version

+ func FormatCustomField(raw json.RawMessage) string

+ type ADFString string

+ func (a *ADFString) UnmarshalJSON(data []byte) error

+ type Attachment struct

+ Author *User

+ Content string

+ Created string

+ Filename string

+ ID string

+ MimeType string

+ Self string

+ Size int64

+ type Board struct

+ ID int

+ Location *BoardLocation

+ Name string

+ Self string

+ Type string

+ type BoardList struct

+ IsLast bool

+ MaxResults int

+ StartAt int

+ Total int

+ Values []Board

+ type BoardLocation struct

+ ProjectID int

+ ProjectKey string

+ ProjectName string

+ type Client struct

+ func New(cfg *config.Config) *Client

+ func (c *Client) AddAttachment(ctx context.Context, issueKey, filePath string) ([]Attachment, error)

+ func (c *Client) AddComment(ctx context.Context, issueKey, body string) (*Comment, error)

+ func (c *Client) AddVote(ctx context.Context, issueKey string) error

+ func (c *Client) AddWatcher(ctx context.Context, issueKey, accountID string) error

+ func (c *Client) AddWorklog(ctx context.Context, issueKey, timeSpent, started, comment string) (*Worklog, error)

+ func (c *Client) AssignIssue(ctx context.Context, issueKey, accountID string) error

+ func (c *Client) CreateComponent(ctx context.Context, projectKey, name, description string) (*Component, error)

+ func (c *Client) CreateIssue(ctx context.Context, req *CreateIssueRequest) (*CreateIssueResponse, error)

+ func (c *Client) CreateProject(ctx context.Context, req *CreateProjectRequest) (*Project, error)

+ func (c *Client) CreateSprint(ctx context.Context, req *CreateSprintRequest) (*Sprint, error)

+ func (c *Client) CreateVersion(ctx context.Context, projectKey, name, description, releaseDate string) (*Version, error)

+ func (c *Client) DeleteAttachment(ctx context.Context, attachmentID string) error

+ func (c *Client) DeleteComment(ctx context.Context, issueKey, commentID string) error

+ func (c *Client) DeleteComponent(ctx context.Context, componentID string) error

+ func (c *Client) DeleteIssue(ctx context.Context, issueKey string, deleteSubtasks bool) error

+ func (c *Client) DeleteIssueLink(ctx context.Context, linkID string) error

+ func (c *Client) DeleteProject(ctx context.Context, projectKey string) error

+ func (c *Client) DeleteVersion(ctx context.Context, versionID string) error

+ func (c *Client) DeleteWorklog(ctx context.Context, issueKey, worklogID string) error

+ func (c *Client) GetBoards(ctx context.Context, projectKey string, maxResults int) (*BoardList, error)

+ func (c *Client) GetComments(ctx context.Context, issueKey string) (*CommentList, error)

+ func (c *Client) GetComponents(ctx context.Context, projectKey string) ([]Component, error)

+ func (c *Client) GetCurrentUser(ctx context.Context) (*User, error)

+ func (c *Client) GetFields(ctx context.Context) ([]Field, error)

+ func (c *Client) GetIssue(ctx context.Context, issueKey string, fields []string) (*Issue, error)

+ func (c *Client) GetIssueLinkTypes(ctx context.Context) (*IssueLinkTypeList, error)

+ func (c *Client) GetIssueTypes(ctx context.Context) ([]IssueType, error)

+ func (c *Client) GetPriorities(ctx context.Context) ([]Priority, error)

+ func (c *Client) GetProject(ctx context.Context, projectKey string) (*Project, error)

+ func (c *Client) GetProjects(ctx context.Context) ([]Project, error)

+ func (c *Client) GetSprintIssues(ctx context.Context, sprintID int) (*SearchResult, error)

+ func (c *Client) GetSprints(ctx context.Context, boardID int, state string) (*SprintList, error)

+ func (c *Client) GetStatuses(ctx context.Context) ([]Status, error)

+ func (c *Client) GetTransitions(ctx context.Context, issueKey string) (*TransitionList, error)

+ func (c *Client) GetUser(ctx context.Context, accountID string) (*User, error)

+ func (c *Client) GetVersions(ctx context.Context, projectKey string) ([]Version, error)

+ func (c *Client) GetVotes(ctx context.Context, issueKey string) (*Votes, error)

+ func (c *Client) GetWatchers(ctx context.Context, issueKey string) (*WatcherList, error)

+ func (c *Client) GetWorklogs(ctx context.Context, issueKey string) (*WorklogList, error)

+ func (c *Client) LinkIssues(ctx context.Context, linkTypeName, inwardKey, outwardKey, comment string) error

+ func (c *Client) RemoveVote(ctx context.Context, issueKey string) error

+ func (c *Client) RemoveWatcher(ctx context.Context, issueKey, accountID string) error

+ func (c *Client) SearchIssues(ctx context.Context, opts SearchOptions) (*SearchResult, error)

+ func (c *Client) SearchUsers(ctx context.Context, query string, maxResults int) ([]User, error)

+ func (c *Client) TransitionIssue(ctx context.Context, issueKey, transitionID string, ...) error

+ func (c *Client) UpdateComment(ctx context.Context, issueKey, commentID, body string) (*Comment, error)

+ func (c *Client) UpdateComponent(ctx context.Context, componentID string, fields map[string]interface{}) (*Component, error)

+ func (c *Client) UpdateIssue(ctx context.Context, issueKey string, req *UpdateIssueRequest) error

+ func (c *Client) UpdateProject(ctx context.Context, projectKey string, fields map[string]interface{}) (*Project, error)

+ func (c *Client) UpdateSprint(ctx context.Context, sprintID int, fields map[string]interface{}) (*Sprint, error)

+ func (c *Client) UpdateVersion(ctx context.Context, versionID string, fields map[string]interface{}) (*Version, error)

+ type Comment struct

+ Author *User

+ Body ADFString

+ Created string

+ ID string

+ Self string

+ Updated string

+ type CommentList struct

+ Comments []Comment

+ MaxResults int

+ StartAt int

+ Total int

+ type Component struct

+ Description string

+ ID string

+ Lead *User

+ Name string

+ Project string

+ type CreateIssueFields struct

+ Assignee *IDObj

+ Components []IDObj

+ Description string

+ DueDate string

+ FixVersions []IDObj

+ IssueType NamedObj

+ Labels []string

+ Parent *IDObj

+ Priority *NamedObj

+ Project IDObj

+ Summary string

+ type CreateIssueRequest struct

+ Fields CreateIssueFields

+ type CreateIssueResponse struct

+ ID string

+ Key string

+ Self string

+ type CreateProjectRequest struct

+ AssigneeType string

+ Description string

+ Key string

+ LeadAccountID string

+ Name string

+ ProjectTypeKey string

+ type CreateSprintRequest struct

+ EndDate string

+ Goal string

+ Name string

+ OriginBoardID int

+ StartDate string

+ type Field struct

+ Custom bool

+ ID string

+ Key string

+ Name string

+ Navigable bool

+ Orderable bool

+ Searchable bool

+ type IDObj struct

+ ID string

+ Key string

+ type Issue struct

+ Fields IssueFields

+ ID string

+ Key string

+ Raw json.RawMessage

+ Self string

+ func (i *Issue) UnmarshalJSON(data []byte) error

+ type IssueFields struct

+ Assignee *User

+ Comment *CommentList

+ Components []NamedObj

+ Created string

+ Description ADFString

+ DueDate string

+ Extra map[string]json.RawMessage

+ FixVersions []NamedObj

+ IssueType NamedObj

+ Labels []string

+ Parent *IssueRef

+ Priority NamedObj

+ Project ProjectShort

+ Reporter *User

+ Status NamedObj

+ Summary string

+ TimeTracking *TimeTracking

+ Updated string

+ Votes *Votes

+ Watches *Watches

+ func (f *IssueFields) UnmarshalJSON(data []byte) error

+ func (f IssueFields) MarshalJSON() ([]byte, error)

+ type IssueLinkType struct

+ ID string

+ Inward string

+ Name string

+ Outward string

+ type IssueLinkTypeList struct

+ IssueLinkTypes []IssueLinkType

+ type IssueRef struct

+ ID string

+ Key string

+ type IssueType struct

+ Description string

+ ID string

+ Name string

+ Subtask bool

+ type NamedObj struct

+ ID string

+ Name string

+ Self string

+ type Priority struct

+ Description string

+ ID string

+ Name string

+ type Project struct

+ Description string

+ ID string

+ IsPrivate bool

+ Key string

+ Lead *User

+ Name string

+ ProjectType string

+ Self string

+ Style string

+ type ProjectShort struct

+ ID string

+ Key string

+ Name string

+ type SearchOptions struct

+ Fields []string

+ JQL string

+ MaxResults int

+ StartAt int

+ type SearchResult struct

+ Issues []Issue

+ MaxResults int

+ StartAt int

+ Total int

+ type Sprint struct

+ CompleteDate string

+ EndDate string

+ Goal string

+ ID int

+ Name string

+ OriginBoardID int

+ StartDate string

+ State string

+ type SprintList struct

+ IsLast bool

+ MaxResults int

+ StartAt int

+ Total int

+ Values []Sprint

+ type Status struct

+ Category NamedObj

+ Description string

+ ID string

+ Name string

+ type TimeTracking struct

+ OriginalEstimate string

+ OriginalEstimateSeconds int

+ RemainingEstimate string

+ RemainingEstimateSeconds int

+ TimeSpent string

+ TimeSpentSeconds int

+ type Transition struct

+ ID string

+ Name string

+ To NamedObj

+ type TransitionList struct

+ Transitions []Transition

+ type UpdateIssueRequest struct

+ Fields map[string]interface{}

+ type User struct

+ AccountID string

+ Active bool

+ DisplayName string

+ EmailAddress string

+ Name string

+ Self string

+ type Version struct

+ Archived bool

+ Description string

+ ID string

+ Name string

+ ProjectID int

+ ReleaseDate string

+ Released bool

+ type Votes struct

+ HasVoted bool

+ Votes int

+ type WatcherList struct

+ IsWatching bool

+ Self string

+ WatchCount int

+ Watchers []User

+ type Watches struct

+ IsWatching bool

+ WatchCount int

+ type Worklog struct

+ Author *User

+ Comment ADFString

+ ID string

+ Self string

+ Started string

+ TimeSpent string

+ TimeSpentSeconds int

+ type WorklogList struct

+ MaxResults int

+ StartAt int

+ Total int

+ Worklogs []Worklog