---
title: "Get a project"
method: GET
path: "/api/projects/{projectName}"
tags: ["projects"]
---

# Get a project

`GET /api/projects/{projectName}`

## Request

- Base URL: `https://api.hostim.dev`
- URL: `https://api.hostim.dev/api/projects/{projectName}`
- Auth: HTTP bearer

Get a project from the database

## Path parameters

- `projectName` string, required

## Response `200`

Project found

- Project
  - `name` string: The project friendly name set by the user
  - `region` string: The project region
  - `id` string, required: The project id generated by the system
  - `allTimeCosts` number: The all time costs of the project
  - `projectedMonthlyCosts` number: The projected monthly costs of the project
  - `deployedServices` number: The number of deployed services
  - `sshKeys` string[], required: The SSH keys for the project
  - `createdAt` string, date-time: The timestamp when the project was created
  - `trialExpiresAt` string, date-time: The timestamp when the project trial expires
  - `accessLevel` 'owner' | 'maintainer': The current user's access level to this project

## Other responses

- `401`: User is not authorized
- `404`: Project not found
- `500`: Internal server error

---

[API](https://skmtc.dev/hostim/apis/hostim-api.md) · [All operations](https://skmtc.dev/hostim/apis/hostim-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostim/apis/hostim-api/revisions/37c35e1026a9?raw)