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
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
projectIdThe project ID.
Response
data.items is an array. Each item:
NameDescription
codeThe deprecation code, such as
mdx.update-label — see Every deprecated form.kindconfig, frontmatter, mdx-tag or mdx-prop.fileThe file — relative to the repository root for config, to the docs folder for pages.
lineThe line in that file.
oldThe deprecated form as the file writes it.
replacementWhat to write instead, for this file's value.
noticeAtWhen the deprecation notice for this code was recorded, or
null if there's none yet.removedAtnoticeAt 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
| Status | Code | When |
|---|---|---|
| 401 | unauthorized | No session token, or an API key |
| 403 | forbidden | You're not in the project's organization |
| 404 | not_found | The project doesn't exist |
Was this page helpful? Yes No
Previous
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations \
-H "Authorization: Bearer <session token>"
const response = await fetch('https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations', {
method: 'GET',
headers: {
'Authorization': 'Bearer <session token>',
},
});
const data = await response.json();
console.log(response.status, data);
import requests
url = "https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations"
headers = {
"Authorization": "Bearer <session token>",
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <session token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <session token>"
response = http.request(request)
puts response.code
puts response.body
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <session token>',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
echo $status, PHP_EOL, $response, PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations"))
.header("Authorization", "Bearer <session token>")
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.syntext.dev/v1/projects/b4c5d6e7-f8a9-4b0c-9d1e-2f3a4b5c6d7e/deprecations");
request.Headers.TryAddWithoutValidation("Authorization", "Bearer <session token>");
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
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"
}
]
}
}