Pennykite

projects.get

Read one project

Returns a single project by ID. The project must belong to the given workspace and you must be an active member; an ID from another workspace returns NOT_FOUND.

Transport: POST /api/rpc/projects/get using the oRPC RPC protocol. Call it through the typed client in app/sdk/client.ts; the request must be same-origin and carry a verified session cookie.

Input

projects.get input fields
FieldTypeRequiredNotes
workspaceIdstringyesmin length 1
idstringyesmin length 1

Output

projects.get output fields
FieldTypeRequiredNotes
namestringyesmin length 1; max length 120
descriptionstringyesdefault ""; max length 4000
idstringyes
workspaceIdstringyes
archivedbooleanyes
versionintegeryesmin -9007199254740991; max 9007199254740991
createdAtstring (ISO 8601 date-time, UTC)yes
updatedAtstring (ISO 8601 date-time, UTC)yes

Errors

CodeStatusWhen
UNAUTHENTICATED401No verified session was sent with the request.
FORBIDDEN403You are not an active member of this workspace, or your role does not allow the action.
NOT_FOUND404No project with this ID exists in the workspace.
CONFLICT409The record changed since you loaded it; reload and try again.
QUOTA_EXCEEDED403The workspace already holds its maximum number of projects (archived projects count).

Was this page helpful?

On this page