Skip to main content

Module queries

Module queries 

Source
Expand description

Generated query functions and builder types.

All query functions are generic over T: DeserializeOwned + GraphQLFields. Pass the generated type for full-schema queries, or define your own lean struct for zero-overfetch.

Generated by lineark-codegen — do not edit.

Structs§

CyclesQueryBuilder
Query builder: All cycles accessible to the user.
DocumentsQueryBuilder
Query builder: All documents the user has access to in the workspace.
IssueLabelsQueryBuilder
Query builder: All issue labels. Returns a paginated list of labels visible to the authenticated user, including both workspace-level and team-scoped labels.
IssueRelationsQueryBuilder
Query builder: All issue relations. Returns a paginated list of all issue relations (blocks, blocked by, relates to, duplicates) visible to the authenticated user.
IssuesQueryBuilder
Query builder: All issues. Returns a paginated list of issues visible to the authenticated user. Can be filtered by various criteria including team, assignee, state, labels, project, and cycle.
ProjectLabelsQueryBuilder
Query builder: Returns all project labels in the workspace, with optional filtering.
ProjectMilestonesQueryBuilder
Query builder: Returns all project milestones in the workspace, with optional filtering.
ProjectStatusesQueryBuilder
Query builder: Returns all project statuses in the workspace.
ProjectsQueryBuilder
Query builder: Returns all projects in the workspace, with optional filtering and sorting.
SearchIssuesQueryBuilder
Query builder: Search issues by text query using full-text and vector search. Results are ranked by relevance unless an orderBy parameter is specified. Supports optional issue filters and comment inclusion. Rate-limited to 30 requests per minute.
TeamsQueryBuilder
Query builder: All teams whose issues the user can access. This includes public teams and private teams the user is a member of. This may differ from administrableTeams, which returns teams whose settings the user can change but whose issues they don’t necessarily have access to.
UsersQueryBuilder
Query builder: All users in the workspace. Supports filtering, sorting, and pagination.
WorkflowStatesQueryBuilder
Query builder: All issue workflow states (issue statuses). Returns a paginated list of workflow states visible to the authenticated user, across all teams they have access to.

Functions§

cycle
One specific cycle, looked up by ID or slug.
cycles
All cycles accessible to the user.
document
A specific document by ID or slug.
documents
All documents the user has access to in the workspace.
issue
One specific issue, looked up by its unique identifier.
issue_labels
All issue labels. Returns a paginated list of labels visible to the authenticated user, including both workspace-level and team-scoped labels.
issue_relation
One specific issue relation, looked up by its unique identifier.
issue_relations
All issue relations. Returns a paginated list of all issue relations (blocks, blocked by, relates to, duplicates) visible to the authenticated user.
issue_vcs_branch_search
Find issue based on the VCS branch name.
issues
All issues. Returns a paginated list of issues visible to the authenticated user. Can be filtered by various criteria including team, assignee, state, labels, project, and cycle.
project
Returns a single project by its identifier or URL slug.
project_labels
Returns all project labels in the workspace, with optional filtering.
project_milestone
Returns a single project milestone by its identifier.
project_milestones
Returns all project milestones in the workspace, with optional filtering.
project_statuses
Returns all project statuses in the workspace.
projects
Returns all projects in the workspace, with optional filtering and sorting.
search_issues
Search issues by text query using full-text and vector search. Results are ranked by relevance unless an orderBy parameter is specified. Supports optional issue filters and comment inclusion. Rate-limited to 30 requests per minute.
team
Fetches a specific team by its ID.
teams
All teams whose issues the user can access. This includes public teams and private teams the user is a member of. This may differ from administrableTeams, which returns teams whose settings the user can change but whose issues they don’t necessarily have access to.
users
All users in the workspace. Supports filtering, sorting, and pagination.
whoami
The currently authenticated user making the API request.
workflow_states
All issue workflow states (issue statuses). Returns a paginated list of workflow states visible to the authenticated user, across all teams they have access to.