Auth

This page has all the methods related to Authentication.

Note that not all endpoints require authentication. Instead, your requests need to have an Authorization: None header.

These endpoints are (mostly) the ones related to the Public Roadmap and Changelog. In the docs, these are marked with OPEN.

For all other endpoints, however, you need to routinely create an access token. Currently, access tokens are valid for 24 hours at a time. Once 24 hours are up, the token expires and needs to be replaced with a new one.

POSTcreateAccessToken

Create an access token

Creates a new access token. See Auth Overview

Params

  • Name
    key
    Type
    string
    Description

    Your API key. Get it here

  • Name
    linearToken
    Type
    string
    (optional)
    Description

    This can be either one of the following:

    • A string in the form of user:<productlane user id> (you likely want this)
    • An OAuth token that can be used to access your linear account

    The token will mostly be used to update linear issues on the behalf of the person who owns the token.

    That means if the person who owns this token loses access to the linear workspace, so will the Productlane API.

Result

  • Name
    result
    Type
    string
    Description

    An access token valid for a limited time. Can be put into the Authorization: Bearer header of your requests to other endpoints. See Auth Overview

Request

POST
/createAccessToken
{
	"params": {
		"key": "eyJhcGl...",
		// required when you want to use the Linear integration:
		"linearToken": "user:5374ad2f-a0fe-4219-9c85-5425d6502701"
	}
}

Response

{
	"result": "RU5fWEl...",
	"error": null
}