// readme

go-backlog

Go client library for Nulab Backlog API

Features

  • Type-safe option builders — Filter and configure requests using strongly-typed option methods (e.g. WithKeyword, WithCount, WithOrder), avoiding raw string/map parameters.
  • Idiomatic Go structs — API responses are mapped to Go structs with proper types (time.Time, typed constants, etc.) instead of raw JSON.
  • Context support — Every API method accepts context.Context for cancellation and timeout control.
  • Structured error types — Errors are returned as typed values (e.g. *APIResponseError for API errors, *ValidationError for invalid arguments), enabling precise handling with errors.As.

Requirements

  • Go >= 1.23

Installation

go get github.com/nattokin/go-backlog

Examples

NewClient authenticates with a Backlog API key, which is sent in the Backlog-API-Key request header.

c, err := backlog.NewClient(
    os.Getenv("BACKLOG_BASE_URL"),
    os.Getenv("BACKLOG_API_KEY"),
)

// Get all Wiki pages in a project.
wikis, err :=…