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
- API
  
  Reference documentation for the pkg.go.dev API
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.0.0

Aug 20, 2026

Changes in this version

type Client

+ func (c *Client) CascadeArchivePage(ctx context.Context, id int64, f api.CascadeArchiveForm) ([]byte, *APIError)

+ func (c *Client) CascadePermanentDeleteFromTrash(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) CascadeRestoreFromTrash(ctx context.Context, pageID int64, f api.CascadeRestoreForm) ([]byte, *APIError)

+ func (c *Client) CascadeTrashPage(ctx context.Context, id int64, f api.CascadeTrashForm) ([]byte, *APIError)

+ func (c *Client) CascadeUnarchivePage(ctx context.Context, pageID int64, f api.CascadeSubtreeForm) ([]byte, *APIError)

+ func (c *Client) GetPublicApiSpec(ctx context.Context) ([]byte, *APIError)

+ func (c *Client) GetTrashedPage(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) ListPagePropertyValues(ctx context.Context, ids []int64) ([]byte, *APIError)

+ func (c *Client) PreviewAdminArchiveCascadeImpact(ctx context.Context, pageID int64, operation string, includeSubtree *bool) ([]byte, *APIError)

+ func (c *Client) PreviewAdminTrashCascadeImpact(ctx context.Context, pageID int64, operation string, includeSubtree *bool) ([]byte, *APIError)

+ func (c *Client) PreviewMovePageType(ctx context.Context, id int64, f api.PageTypeMovePreviewRequest) ([]byte, *APIError)

+ func (c *Client) PreviewPageCascadeImpact(ctx context.Context, id int64, operation string) ([]byte, *APIError)

v0

v0.0.4

Aug 5, 2026

v0.0.3

Aug 5, 2026

v0.0.2

Aug 5, 2026

v0.0.1

Aug 5, 2026

Changes in this version

+ var ErrResponseTooLarge = errors.New("response too large")

+ type APIError struct

+ Body []byte

+ Malformed bool

+ Problem *problem.Problem

+ Status int

+ TooLarge *ResponseTooLargeError

+ Transport error

+ func APIErrorFromRead(err error) *APIError

+ func Do[T any](c *Client, call LowLevel) (*T, *APIError)

+ func (e *APIError) Error() string

+ func (e *APIError) ExitCode() int

+ type AuditFilters struct

+ ActionType string

+ Actor string

+ EntityID int64

+ EntityType string

+ From string

+ Include []string

+ Search string

+ To string

+ type Client struct

+ func New(baseURL, apiKey string) (*Client, error)

+ func (c *Client) ActivateGroup(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) AddAccess(ctx context.Context, pageID int64, f api.PageRestrictionAccessForm) ([]byte, *APIError)

+ func (c *Client) AddGroupAccess(ctx context.Context, pageID int64, f api.PageRestrictionGroupAccessForm) ([]byte, *APIError)

+ func (c *Client) AddGroupMember(ctx context.Context, id int64, f api.AddMemberForm) ([]byte, *APIError)

+ func (c *Client) AddWorkItemTransition(ctx context.Context, typeSlug string, f api.WorkItemTransitionCreateForm) ([]byte, *APIError)

+ func (c *Client) ArchivePage(ctx context.Context, id int64, f api.ArchivePageForm) ([]byte, *APIError)

+ func (c *Client) CommentWorkItem(ctx context.Context, pageID, workItemID int64, f api.WorkItemCommentForm) ([]byte, *APIError)

+ func (c *Client) CreateDomainEnum(ctx context.Context, f api.DomainEnumForm) ([]byte, *APIError)

+ func (c *Client) CreateExternalUser(ctx context.Context, f api.ExternalUserForm) ([]byte, *APIError)

+ func (c *Client) CreateGroup(ctx context.Context, f api.UserGroupForm) ([]byte, *APIError)

+ func (c *Client) CreatePage(ctx context.Context, name string, pageTypeID int64, parentID *int64, ...) ([]byte, *APIError)

+ func (c *Client) CreatePageForm(ctx context.Context, form api.PageCreateForm) ([]byte, *APIError)

+ func (c *Client) CreatePageType(ctx context.Context, f api.PageTypeForm) ([]byte, *APIError)

+ func (c *Client) CreatePropertyDescriptor(ctx context.Context, pageTypeID int64, f api.PropertyDescriptorForm) ([]byte, *APIError)

+ func (c *Client) CreateRestriction(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) CreateWorkItem(ctx context.Context, pageID int64, f api.WorkItemCreateForm) ([]byte, *APIError)

+ func (c *Client) CreateWorkItemType(ctx context.Context, f api.WorkItemTypeCreateForm) ([]byte, *APIError)

+ func (c *Client) DeactivateGroup(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeleteArchivedPage(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) DeleteDomainEnum(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeleteFileAttachment(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeleteImage(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeletePage(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeletePageType(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeletePropertyDescriptor(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeleteUser(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DeleteWorkItem(ctx context.Context, pageID, workItemID int64) ([]byte, *APIError)

+ func (c *Client) DeleteWorkItemType(ctx context.Context, slug string) ([]byte, *APIError)

+ func (c *Client) DiscardWorkingRevision(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) DoConditional(call LowLevel) (body []byte, notModified bool, apiErr *APIError)

+ func (c *Client) DoDownload(call LowLevel) (body io.ReadCloser, notModified bool, apiErr *APIError)

+ func (c *Client) DoRaw(call LowLevel) ([]byte, *APIError)

+ func (c *Client) DownloadAttachment(ctx context.Context, id int64, ifNoneMatch string) (io.ReadCloser, bool, *APIError)

+ func (c *Client) DownloadImage(ctx context.Context, id int64, ifNoneMatch string) (io.ReadCloser, bool, *APIError)

+ func (c *Client) EditWorkItem(ctx context.Context, pageID, workItemID int64, f api.WorkItemEditForm) ([]byte, *APIError)

+ func (c *Client) GetArchivedPage(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) GetAvailablePropertyDescriptors(ctx context.Context, pageTypeID int64) ([]byte, *APIError)

+ func (c *Client) GetChainLinkOptions(ctx context.Context, pageTypeID, pageID int64) ([]byte, *APIError)

+ func (c *Client) GetContentMacroDocs(ctx context.Context) ([]byte, *APIError)

+ func (c *Client) GetContentMacroDocsByName(ctx context.Context, name string) ([]byte, *APIError)

+ func (c *Client) GetDomainEnum(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) GetDomainEnumUsages(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) GetGroup(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) GetLandingSettings(ctx context.Context) ([]byte, *APIError)

+ func (c *Client) GetPage(ctx context.Context, id int64, expand []string) ([]byte, *APIError)

+ func (c *Client) GetPageType(ctx context.Context, id int64, expand []string) ([]byte, *APIError)

+ func (c *Client) GetPagesTree(ctx context.Context, ifNoneMatch string) (body []byte, notModified bool, err *APIError)

+ func (c *Client) GetPropertyDescriptor(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) GetReleaseNoteByVersion(ctx context.Context, version string) ([]byte, *APIError)

+ func (c *Client) GetRevisionSnapshot(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) GetUser(ctx context.Context, id int64, expand []string) ([]byte, *APIError)

+ func (c *Client) GetWorkItem(ctx context.Context, pageID, workItemID int64) ([]byte, *APIError)

+ func (c *Client) GetWorkItemTransitions(ctx context.Context, pageID, workItemID int64) ([]byte, *APIError)

+ func (c *Client) GetWorkItemType(ctx context.Context, slug string) ([]byte, *APIError)

+ func (c *Client) GetWorkflowRoles(ctx context.Context, include string) ([]byte, *APIError)

+ func (c *Client) ListArchive(ctx context.Context, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListContentMacros(ctx context.Context, context string) ([]byte, *APIError)

+ func (c *Client) ListDomainEnums(ctx context.Context, expand []string) ([]byte, *APIError)

+ func (c *Client) ListDraftsQueue(ctx context.Context, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListGroups(ctx context.Context, status string, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListPageImages(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) ListPageTypes(ctx context.Context) ([]byte, *APIError)

+ func (c *Client) ListPages(ctx context.Context, page, size int, sort []string, pageTypeID *int64) (*api.PagePageListResult, *APIError)

+ func (c *Client) ListPublishQueue(ctx context.Context, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListReleaseNotes(ctx context.Context, page, size int) ([]byte, *APIError)

+ func (c *Client) ListReviewQueue(ctx context.Context, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListRevisions(ctx context.Context, id int64, compare string) ([]byte, *APIError)

+ func (c *Client) ListTrash(ctx context.Context, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListUsers(ctx context.Context, status string, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListWorkItemTypes(ctx context.Context, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) ListWorkItems(ctx context.Context, pageID int64, typ string) ([]byte, *APIError)

+ func (c *Client) Me(ctx context.Context) ([]byte, *APIError)

+ func (c *Client) MovePage(ctx context.Context, id int64, f api.PageMoveForm) ([]byte, *APIError)

+ func (c *Client) MovePageType(ctx context.Context, id int64, f api.PageTypeMoveForm) ([]byte, *APIError)

+ func (c *Client) PatchPage(ctx context.Context, id int64, f api.PagePatchForm) ([]byte, *APIError)

+ func (c *Client) PerformTransition(ctx context.Context, id int64, f api.TransitionForm) ([]byte, *APIError)

+ func (c *Client) PermanentDeleteUser(ctx context.Context, id int64, f api.PermanentDeleteForm) ([]byte, *APIError)

+ func (c *Client) PurgeFromTrash(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) ReactivateUser(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) RemoveAccess(ctx context.Context, pageID, accessID int64) ([]byte, *APIError)

+ func (c *Client) RemoveGroupAccess(ctx context.Context, pageID, accessID int64) ([]byte, *APIError)

+ func (c *Client) RemoveGroupMember(ctx context.Context, id, userID int64) ([]byte, *APIError)

+ func (c *Client) RemoveRestriction(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) RemoveWorkItemTransition(ctx context.Context, typeSlug string, transitionID int64) ([]byte, *APIError)

+ func (c *Client) RestoreFromTrash(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) RestoreVersion(ctx context.Context, id int64, revisionNumber int32) ([]byte, *APIError)

+ func (c *Client) ScanMacroUsage(ctx context.Context, macroName string) ([]byte, *APIError)

+ func (c *Client) SearchAuditLog(ctx context.Context, f AuditFilters, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) SearchGroups(ctx context.Context, query string, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) SearchPages(ctx context.Context, query string, page, size int, allowedPageTypeID *int64) ([]byte, *APIError)

+ func (c *Client) SearchUsers(ctx context.Context, query string, page, size int, sort []string) ([]byte, *APIError)

+ func (c *Client) SetGroupWorkflowRole(ctx context.Context, groupID int64, f api.WorkflowRoleForm) ([]byte, *APIError)

+ func (c *Client) SetUserWorkflowRole(ctx context.Context, userID int64, f api.WorkflowRoleForm) ([]byte, *APIError)

+ func (c *Client) SortChildren(ctx context.Context, parentID int64, childIDs []int64) ([]byte, *APIError)

+ func (c *Client) SortDisplayColumns(ctx context.Context, descriptorID int64, ids []int64) ([]byte, *APIError)

+ func (c *Client) SortPropertyDescriptors(ctx context.Context, pageTypeID int64, ids []int64) ([]byte, *APIError)

+ func (c *Client) StartRevision(ctx context.Context, id int64) ([]byte, *APIError)

+ func (c *Client) SwapPropertyDescriptors(ctx context.Context, fromID, toID int64) ([]byte, *APIError)

+ func (c *Client) TransitionWorkItem(ctx context.Context, pageID, workItemID int64, f api.WorkItemTransitionForm) ([]byte, *APIError)

+ func (c *Client) UnarchivePage(ctx context.Context, pageID int64) ([]byte, *APIError)

+ func (c *Client) UpdateAccess(ctx context.Context, pageID, accessID int64, f api.PageRestrictionAccessForm) ([]byte, *APIError)

+ func (c *Client) UpdateDomainEnum(ctx context.Context, id int64, f api.DomainEnumForm) ([]byte, *APIError)

+ func (c *Client) UpdateGroup(ctx context.Context, id int64, f api.UserGroupForm) ([]byte, *APIError)

+ func (c *Client) UpdateGroupAccess(ctx context.Context, pageID, accessID int64, ...) ([]byte, *APIError)

+ func (c *Client) UpdateLandingSettings(ctx context.Context, f api.LandingSettingsForm) ([]byte, *APIError)

+ func (c *Client) UpdatePage(ctx context.Context, id int64, f api.PageEditForm) ([]byte, *APIError)

+ func (c *Client) UpdatePageType(ctx context.Context, id int64, f api.PageTypeForm) ([]byte, *APIError)

+ func (c *Client) UpdatePropertyDescriptor(ctx context.Context, id int64, f api.PropertyDescriptorForm) ([]byte, *APIError)

+ func (c *Client) UpdateUser(ctx context.Context, id int64, f api.UserForm) ([]byte, *APIError)

+ func (c *Client) UpdateWorkItemTransition(ctx context.Context, typeSlug string, transitionID int64, ...) ([]byte, *APIError)

+ func (c *Client) UpdateWorkItemType(ctx context.Context, slug string, f api.WorkItemTypeUpdateForm) ([]byte, *APIError)

+ func (c *Client) UploadAttachment(ctx context.Context, pageID int64, filePath string) ([]byte, *APIError)

+ func (c *Client) UploadPageImage(ctx context.Context, pageID int64, filePath string) ([]byte, *APIError)

+ func (c *Client) ValidateContent(ctx context.Context, f api.PublicContentValidationForm) ([]byte, *APIError)

+ type LowLevel func() (*http.Response, error)

+ type ResponseTooLargeError struct

+ Limit int64

+ Status int

+ func (e *ResponseTooLargeError) Error() string

+ func (e *ResponseTooLargeError) Unwrap() error