markus41/Linear SDK Usage

Linear SDK (@linear/sdk)

References:

• SDK overview: https://linear.app/developers/sdk
• Advanced usage: https://linear.app/developers/advanced-usage
• Fetch / modify: https://linear.app/developers/sdk-fetching-and-modifying-data
• Errors: https://linear.app/developers/sdk-errors
• Create issues with linearCreate: https://linear.app/developers/create-issues-using-linear-new

Initialisation

import { LinearClient } from "@linear/sdk";
const client = new LinearClient({ apiKey: process.env.LINEAR_API_KEY });

For OAuth:

const client = new LinearClient({ accessToken: token });

For actor mode:

const client = new LinearClient({
  accessToken: token,
  headers: { "Linear-Actor-Token": actorToken }
});

Fetching with lazy connections

The SDK returns LinearFetch<T> — promises that auto-resolve nested connections:

const team = await client.team("ENG");
const issues = await team.issues({ first: 50 });
for (const issue of issues.nodes) {
  const assignee = await issue.assignee;  // lazy fetch — second round-trip
}

Pitfall: lazy access fires N+1 queries. Use client.issues({ filter, includeArchived: false }) with a GraphQL query that selects nested fields up front (drop into raw GraphQL via client.client.rawRequest()).

Mutations

const result = await client.createIssue({
  teamId, title, description, priority: 1
});
if (!result.success) throw new Error("Create failed");
const issue = await result.issue;

Errors

The SDK throws typed errors:

• AuthenticationError — token bad
• UserError — your input invalid (validation)
• RatelimitedError — back off; check headers.get("X-RateLimit-Reset")
• NetworkError — retry with exponential backoff
• GraphqlError — server-side; capture errors[].extensions.code
• See: https://linear.app/developers/sdk-errors

Pagination helper

async function* paginate(query, vars) {
  let cursor;
  do {
    const page = await query({ ...vars, after: cursor });
    yield* page.nodes;
    cursor = page.pageInfo.hasNextPage ? page.pageInfo.endCursor : null;
  } while (cursor);
}

Used by lib/pagination.ts.

Creating issues with linear.new

For UI-mediated creation (deep-link), see https://linear.app/developers/create-issues-using-linear-new — useful for triage flows that need user input.