Skip to content
Governance Platform

Get project

GET
/api/v1/organizations/{orgId}/projects/{projectId}
 
curl --request GET \
  --url https://localhost:10001/api/v1/organizations/example/projects/example \
  --header 'Authorization: <Authorization>'

Retrieve a specific project by its ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
orgId
required
string

Organization ID or UUID (urn:uuid optional)

projectId
required
string

Project ID, UUID (urn:uuid optional), or slug:my-project

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Project

Media type application/json

An AI initiative within an organization, and the scope most access is granted against

object
archivedAt

Set via the archive endpoint

string format: date-time
createdAt
string format: date-time
description
string
id
integer
isArchived

Set via the archive endpoint

boolean
name
string
organizationId

Taken from the path on create

integer
slug

Derived from name

string
updatedAt
string format: date-time
uuid

Urn:uuid form

string
Example generated
{
  "description": "example",
  "name": "example"
}

400

Section titled “400 ”

Bad request - Invalid project ID

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

403

Section titled “403 ”

Forbidden - No project access

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

404

Section titled “404 ”

Project not found

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}

500

Section titled “500 ”

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object
error
string
Example 
{
  "error": "Invalid request body"
}