Skip to content

The people and the agents an item can be assigned to, read from the tracker.

GET
/docs/{docId}/breakdown/assignees
curl --request GET \
--url 'https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/breakdown/assignees?tracker=linear&target=example'
docId
required
string format: uuid

The ID of one spec doc.

tracker
required
string
Allowed values: linear jira github
target
required
string

The Linear team, the Jira project URL, or the GitHub repo.

query
string

The assignees. Agents are marked apart from people.

Media typeapplication/json
object
items
required
Array<object>
object
kind
required
string
Allowed values: person agent
id
required

The tracker’s ID for the person or the agent.

string
name
required
string
Example
{
"items": [
{
"kind": "person"
}
]
}

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"code": "example"
}