Skip to content

Get project by UUID

GET
/api/v1/projects/by-uuid/{projectUUID}
curl --request GET \
--url https://localhost:10001/api/v1/projects/by-uuid/example \
--header 'Authorization: <Authorization>'

Retrieve a specific project by its immutable UUID

projectUUID
required
string

Project UUID

Project

Media type application/json
object
archivedAt
string
createdAt
string
description
string
id
integer
isArchived
boolean
name
string
organizationId
integer
status

Status field from auth-service

string
updatedAt
string
uuid
string
Example generated
{
"archivedAt": "example",
"createdAt": "example",
"description": "example",
"id": 1,
"isArchived": true,
"name": "example",
"organizationId": 1,
"status": "example",
"updatedAt": "example",
"uuid": "example"
}

Bad request - Invalid project UUID

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Forbidden - No project access

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Project not found

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Internal server error

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}