API reference

Get a project

GET/v1/projects/{projectId}

Authorization

Send a personal API key or an OAuth access token as Authorization: Bearer <token>.

OAuth scopes: projects:read

Parameters

projectIdstring (uuid), pathrequired

Responses

200Success

projectobjectrequired
idstringrequired
namestringrequired
descriptionstring | nullrequired
visibility"private" | "team"required
memoryScope"project" | "workspace"required
taskCountnumberrequired
createdAtstringrequired
updatedAtstringrequired

400Invalid request

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

401Missing or invalid Bearer credential

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

402Payment or subscription required

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

403Credential is missing a required scope

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

404Resource not found

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

409Request conflict

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

429Rate limit exceeded

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

500Internal API error

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

curl --request GET \
  --url 'https://api.staging.adam.new/v1/projects/{projectId}' \
  --header 'Authorization: Bearer <token>'

{
  "project": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "visibility": "private",
    "memoryScope": "project",
    "taskCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}