/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference List Project Deprecations

List Project Deprecations

The deprecated syntax a project's last production build used, with the file, line, replacement and removal date

GET/v1/projects/{projectId}/deprecationsTry it
Session token

Returns every use of deprecated syntax found by the project's last production build — config keys, frontmatter keys, MDX tags and props, and unknown keys — with the dates from the deprecation notice. The dashboard's deprecation banner reads this.

Any member of the project's organization can call it. It needs a session token — API keys get 401.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Response

data.items is an array. Each item:

NameDescription
code:string
The deprecation code, such as mdx.update-label — see Every deprecated form.
kind:string
config, frontmatter, mdx-tag or mdx-prop.
file:string
The file — relative to the repository root for config, to the docs folder for pages.
line:number
The line in that file.
old:string
The deprecated form as the file writes it.
replacement:string
What to write instead, for this file's value.
noticeAt:string | null
When the deprecation notice for this code was recorded, or null if there's none yet.
removedAt:string | null
noticeAt plus 14 days — from then on the build fails on this form. null without a notice.

The list is replaced by every production build, so it's empty once a build runs without deprecated syntax.

Error Responses

StatusCodeWhen
401unauthorizedNo session token, or an API key
403forbiddenYou're not in the project's organization
404not_foundThe project doesn't exist
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations \
-H "Authorization: Bearer <session token>"
Responseapplication/json
json
{
"data": {
"items": [
{
"code": "mdx.update-label",
"kind": "mdx-prop",
"file": "changelog.mdx",
"line": 12,
"old": "<Update label=\"…\">",
"replacement": "<Update title=\"…\">",
"noticeAt": "2026-11-17T09:00:00.000Z",
"removedAt": "2026-12-01T09:00:00.000Z"
}
]
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext