Linear API Endpoints

This page provides a comprehensive reference for all Linear API endpoints available through the Corsair plugin. All endpoints are accessed via GraphQL under the hood, but Corsair provides a clean, typed interface.

Issues

Issues are the core work items in Linear. They represent tasks, bugs, features, or any other trackable work.

list

issues.list

List issues with optional filtering by team and pagination support.

const result = await corsair.linear.api.issues.list({
    teamId: "team-id", 
    first: 50,
    after: "cursor",
});

Parameters:

Returns: IssueConnection with nodes array and pageInfo for pagination.

get

issues.get

Get a single issue by ID with full details including project, cycle, labels, and subscribers.

const issue = await corsair.linear.api.issues.get({
    id: "issue-id", 
});

Parameters:

Returns: Issue object with complete details.

create

issues.create

Create a new issue in a team.

const issue = await corsair.linear.api.issues.create({
    title: "Implement user authentication", 
    description: "Add JWT-based authentication", 
    teamId: "team-id", 
    priority: 1,
    assigneeId: "user-id",
    stateId: "state-id",
});

Parameters:

Returns: Created Issue object.

update

issues.update

Update an existing issue.

const issue = await corsair.linear.api.issues.update({
    id: "issue-id", 
    input: { 
        title: "Updated title", 
        priority: 1, 
        stateId: "completed-state-id", 
    }, 
});

Parameters:

Returns: Updated Issue object.

delete

issues.delete

Delete an issue.

const success = await corsair.linear.api.issues.delete({
    id: "issue-id", 
});

Parameters:

Returns: boolean indicating success.

Projects

Projects help organize and track work across multiple issues and teams.

list

projects.list

List all projects with pagination support.

const result = await corsair.linear.api.projects.list({
    first: 50,
    after: "cursor",
});

Parameters:

Returns: ProjectConnection with nodes array and pageInfo for pagination.

get

projects.get

Get a single project by ID with full details.

const project = await corsair.linear.api.projects.get({
    id: "project-id", 
});

Parameters:

Returns: Project object with complete details.

create

projects.create

Create a new project.

const project = await corsair.linear.api.projects.create({
    name: "Q1 2024 Roadmap", 
    description: "Goals and initiatives for Q1", 
    teamIds: ["team-id-1", "team-id-2"], 
    state: "started",
    priority: 1,
});

Parameters:

Returns: Created Project object.

update

projects.update

Update an existing project.

const project = await corsair.linear.api.projects.update({
    id: "project-id", 
    input: { 
        state: "completed", 
        targetDate: "2024-03-31", 
    }, 
});

Parameters:

Returns: Updated Project object.

delete

projects.delete

Delete a project.

const success = await corsair.linear.api.projects.delete({
    id: "project-id", 
});

Parameters:

Returns: boolean indicating success.

Teams

Teams are groups of users that work together on issues and projects.

list

teams.list

List all teams with pagination support.

const result = await corsair.linear.api.teams.list({
    first: 50,
    after: "cursor",
});

Parameters:

Returns: TeamConnection with nodes array and pageInfo for pagination.

get

teams.get

Get a single team by ID.

const team = await corsair.linear.api.teams.get({
    id: "team-id", 
});

Parameters:

Returns: Team object with details.

Comments

Comments allow discussion and collaboration on issues.

list

comments.list

List all comments on an issue with pagination support.

const result = await corsair.linear.api.comments.list({
    issueId: "issue-id", 
    first: 50,
    after: "cursor",
});

Parameters:

Returns: CommentConnection with nodes array and pageInfo for pagination.

create

comments.create

Create a new comment on an issue.

const comment = await corsair.linear.api.comments.create({
    issueId: "issue-id", 
    body: "Great work on this! 👍", 
    parentId: "parent-comment-id", // Optional for replies
});

Parameters:

Returns: Created Comment object.

update

comments.update

Update an existing comment.

const comment = await corsair.linear.api.comments.update({
    id: "comment-id", 
    input: { 
        body: "Updated comment text", 
    }, 
});

Parameters:

Returns: Updated Comment object.

delete

comments.delete

Delete a comment.

const success = await corsair.linear.api.comments.delete({
    id: "comment-id", 
});

Parameters:

Returns: boolean indicating success.

Common Types

Priority Levels

Linear uses numeric priority levels:

• 0 - No priority
• 1 - Urgent
• 2 - High
• 3 - Medium (default)
• 4 - Low

Project States

Projects can be in one of these states:

• planned - Not yet started
• started - Currently in progress
• paused - Temporarily on hold
• completed - Successfully finished
• canceled - Abandoned

Pagination

All list endpoints support cursor-based pagination:

let cursor: string | undefined;
const allIssues = [];

do {
    const result = await corsair.linear.api.issues.list({
        first: 50,
        after: cursor,
    });
    
    allIssues.push(...result.nodes);
    cursor = result.pageInfo.hasNextPage ? result.pageInfo.endCursor : undefined;
} while (cursor);