Working with the GraphQL API
Linear's public API is built using GraphQL. It's the same API we use internally for developing our applications.
If you're new to GraphQL, Apollo has resources for beginners. The official documentation is another good starting point.
Linear's GraphQL endpoint is:
https://api.linear.app/graphql
It supports introspection so you can query the whole schema.
Right now we support personal API keys and OAuth2 authentication.
If you're building an application for others to use, we recommend you use OAuth2 authentication. Once you completed the authentication flow and acquired an access token, you can pass it in the
Authorization header:curl \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <Replace this with your access token>" \
--data '{ "query": "{ issues { nodes { id title } } }" }' \
https://api.linear.app/graphql
For personal scripts API keys are the easiest way to access the API. They can be created in the API settings. To authenticate your requests, you need to pass the newly created key as an
Authorization header:curl \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: <Replace this with your API Key>" \
--data '{ "query": "{ issues { nodes { id title } } }" }' \
https://api.linear.app/graphql
The Linear SDK exposes the Linear GraphQL schema, and makes it easy to access models, or perform mutations. We recommend using it to interact with the GraphQL API. It is written in TypeScript, allowing all operations to be strongly typed.
Insomnia is a free HTTP client that supports GraphQL. GraphQL Playground from Prisma is a dedicated GraphQL client that also has a desktop app.
Point the GraphQL client to the Linear production API endpoint:
https://api.linear.app/graphql
Once you have your client installed, you can start making queries (read) and mutations (write) to the API.
To get information about the authenticated user, you can use the
viewer query:query Me {
viewer {
id
name
email
}
}
As issues (and most other objects) are team based, you first need to get the ID of the team you want to interact with:
query Teams {
teams {
nodes {
id
name
}
}
}
Once you have found the correct team, you can get the issues for that team. Lets make a request with also some other issue metadata:
query Team {
team(id: "9cfb482a-81e3-4154-b5b9-2c805e70a02d") {
id
name
issues {
nodes {
id
title
description
assignee {
id
name
}
createdAt
archivedAt
}
}
}
}
We can also get an issue by id:
query Issue {
issue(id: "BLA-123") {
id
title
description
}
}
To get the full list of available queries and mutations, introspect the API schema using your favorite GraphQL client.
To create a new issue, we'll need to create a mutation:
mutation IssueCreate {
issueCreate(
input: {
title: "New exception"
description: "More detailed error report in markdown"
teamId: "9cfb482a-81e3-4154-b5b9-2c805e70a02d"
}
) {
success
issue {
id
title
}
}
}
This mutation will create a new issue and return its
id and title if the call was successful (success: true).If an issue is created without a specified
stateId(the status field for the issue), the issue will be assigned to the team's first state in the Backlog workflow state category. If the "Triage" feature is turned on for the team, then the issue will be assigned to the Triage workflow state.A common use case after creating an issue is updating the issue. To do this we can use the
issueUpdate mutation, using the input field to include whatever it is we want to change. The id provided can be either be the uuid returned by the creation query, or the shorthand id like BLA-123 below.mutation IssueUpdate {
issueUpdate(
id: "BLA-123",
input: {
title: "New Issue Title"
stateId: "NEW-STATE-ID",
}
) {
success
issue {
id
title
state {
id
name
}
}
}
}
Linear hosts images and other assets uploaded into Linear behind authentication. Only authenticated users can view their assets. This also applies to the API and all images will require authentication to be displayed outside Linear's application. Regular API authentication (OAuth or API keys) is accepted for displaying images. If you're displaying images outside Linear's applications, you should download and self-host them in your application's environment.
If you're working on building an application which display Linear data and you want the information to update (near) realtime, you have few options. To prevent excessive usage of our API, we recommend that you be mindful about your implementation.
Lets say you're displaying a big number of issues in your application and want to update them:
Do's:
- Register a programmatic webhook and get updates for all issues for the team. When you detect changes, update the issue information. You can also automatically register webhooks for OAuth applications.
- If you have to poll recent changes, order results by returning recently updated issue first. See Pagination section above how to implement this
Dont's:
- Poll updates for each issue in the application. There should never be a reason to do this and your application might get rate limited. See above tactics to implement this better
There are many ways to fetch issues. One common use case is to get all the issues assigned to a user.
First let's find our user's id:
query {
users {
nodes {
name
id
}
}
}
Now we can use the
assignedIssues field on User:query {
user(id: "USERID") {
id
name
assignedIssues {
nodes {
id
title
}
}
}
}
We can do the same thing with
workflowStates which represent status fields for teams:query {
workflowStates {
nodes {
id
name
}
}
}
query {
workflowState(id: "WORKFLOW_ID") {
issues {
nodes {
title
}
}
}
}
Archived resources are hidden by default from the paginated responses. They can be included by passing optional
includeArchived: true as a query parameter for pagination.If you run into problems or have questions or suggestions, you can join our customer Slack or send us a note ([email protected]). Both options are available through the user menu in the Linear application.
Last modified 1yr ago