Skip to content

One mission, with its sources

GET
/v1/missions/{id}
curl --request GET \
--url https://beta-api.plune.ai/v1/missions/example \
--header 'Authorization: Bearer <token>'

By id, from your project only — another project’s mission reads as 404. Its sources are listed oldest first.

id
required
string

The mission’s id

The mission

Media type application/json
object
id
required
string
projectId
required
string
name
required
string
summary
required

What the product is, in a few sentences; empty until written

string
url
required

Where the product is reached

string
nullable
state
required
string
Allowed values: draft active done
documentation
required

Is there documentation? unknown until somebody answers; provided — it is among the sources; none — the product has none

string
Allowed values: unknown provided none
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
sources
required

Oldest first

Array<object>
object
id
required
string
kind
required

A link of four kinds, added by POST /v1/missions/{id}/sources; or file, uploaded by POST /v1/missions/{id}/files

string
Allowed values: file url openapi repo ticket
ref
required

The link; a file source’s file name

string
title
required
string
nullable
version
required

The source’s version as its owner names it: a commit, a tag, a document’s revision, an ETag

string
nullable
addedBy
required

The user who added it: the person, or the person whose token the agent used

string
createdAt
required
string format: date-time
bytes

A file source only: its size in UTF-8 bytes

integer
mediaType

A file source only: its type, read off its name

string
Allowed values: text/plain text/markdown application/json
Example
{
"id": "6f1c2b3a-0000-4000-8000-000000002188",
"projectId": "u-shop::default",
"name": "Shop checkout",
"summary": "An online shop. A customer fills a cart, pays by card or with a voucher, and gets a receipt by email.",
"url": "https://shop.example.com",
"state": "draft",
"documentation": "provided",
"createdBy": "6f1c2b3a-0000-4000-8000-0000000000a2",
"createdAt": "2026-11-04T09:00:00.000Z",
"updatedAt": "2026-11-04T09:05:00.000Z",
"sources": [
{
"id": "6f1c2b3a-0000-4000-8000-000000002189",
"kind": "openapi",
"ref": "https://shop.example.com/openapi.json",
"title": "Shop API",
"version": "2026-11-01",
"addedBy": "6f1c2b3a-0000-4000-8000-0000000000a2",
"createdAt": "2026-11-04T09:05:00.000Z"
}
]
}

No / invalid token or session

No such mission in your project

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}