Skip to main content
GET
Get a project

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The visible project.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
name
string
required
Required string length: 1 - 128
Pattern: ^\S(?:.*\S)?$
handle
string
required
Required string length: 5 - 59
Pattern: ^[a-z]+-[a-z]+-[a-z]+$
data_mode
enum<string>
default:shared
required

Chosen when the project is created. shared uses one database and a shared file namespace across Dev/Prod; isolated keeps their database/Auth records and files separate. Skills recommend isolated development, but the customer chooses the additional measured database consumption. Promotion applies pending schema migrations to an isolated Prod database without copying Dev data. Changing an established mode requires an explicit data migration.

Available options:
shared,
isolated
created_at
string<date-time>
required