# Get a project

One project, its sites and its latest score. Handy after a scan to watch the grade move.

```
GET https://api.rustine.io/v1/projects/{project_id}
```

OAuth permission: `scans:read` · an API key has them all

## Path parameters

- `project_id` (string, required) Project id.

## Response (200 OK)

- `id` (string, required) Project id.
- `object` (string, required)
- `name` (string, required) Project name.
- `score` (number | null, required) Score out of 100; null before the first finished scan.
- `grade` (string | null, required) Grade from A to F; null before the first finished scan. (`A`, `B`, `C`, `D`, `F`)
- `open_issues` (integer, required) Open issues across the project's targets, hidden ones included.
- `paused` (boolean, required) Paused because the plan covers fewer projects: readable, but no scan, recheck, fix or new address.
- `last_scan_at` (string | null, required) End of the last finished scan of any target.
- `targets` (array of object, required)
  - `id` (string, required) Target id: a site (domain) or a GitHub repository of the project.
  - `object` (string, required)
  - `project_id` (string, required) Project the target belongs to.
  - `kind` (string, required) `domain` (a site) or `repository`. (`domain`, `server`, `repository`)
  - `address` (string, required) Hostname of a site (`app.example.com`) or `owner/repo` of a repository.
  - `verified` (boolean, required) Whether the workspace proved it controls this target. Without proof, issue details stay hidden and only quick scans run.
  - `score` (number | null, required) Score out of 100; null before the first finished scan.
  - `grade` (string | null, required) Grade from A to F; null before the first finished scan. (`A`, `B`, `C`, `D`, `F`)
  - `last_scan_at` (string | null, required) End of the last finished scan.
  - `hidden_issues` (object | null, required) Unverified site: what its hidden issues amount to, counts only (never which, nor where). Null when nothing is hidden.
    - `urgent` (integer, required) Open critical and high issues hidden until the site is verified.
    - `later` (integer, required) Open medium and low issues hidden until the site is verified.

## Examples

### curl

```bash
# The key stays in a variable, never in the address
curl https://api.rustine.io/v1/projects/4f9c2a7e-1b3d-4e5f-8a6b-7c8d9e0f1a2b \
  -H "Authorization: Bearer $RUSTINE_API_KEY"
```

### Node

```js
const res = await fetch(
  "https://api.rustine.io/v1/projects/4f9c2a7e-1b3d-4e5f-8a6b-7c8d9e0f1a2b",
  {
    headers: {
      Authorization: `Bearer ${process.env.RUSTINE_API_KEY}`,
    },
  },
)
const project = await res.json()
```

### Python

```python
import os

import requests

project = requests.get(
    "https://api.rustine.io/v1/projects/4f9c2a7e-1b3d-4e5f-8a6b-7c8d9e0f1a2b",
    headers={
        "Authorization": f"Bearer {os.environ['RUSTINE_API_KEY']}",
    },
).json()
```

### Response: 200 OK

```json
{
  "id": "4f9c2a7e-1b3d-4e5f-8a6b-7c8d9e0f1a2b",
  "object": "project",
  "name": "Example SaaS",
  "score": 62,
  "grade": "C",
  "open_issues": 3,
  "paused": false,
  "last_scan_at": "2026-10-13T08:42:10.000Z",
  "targets": [
    {
      "id": "8d2e4f6a-9b1c-4d3e-a5f7-0b2c4d6e8f1a",
      "object": "target",
      "project_id": "4f9c2a7e-1b3d-4e5f-8a6b-7c8d9e0f1a2b",
      "kind": "domain",
      "address": "app.example.com",
      "verified": true,
      "score": 62,
      "grade": "C",
      "last_scan_at": "2026-10-13T08:42:10.000Z",
      "hidden_issues": null
    },
    {
      "id": "c1a3e5f7-2b4d-4f6a-8c0e-1a3b5c7d9e2f",
      "object": "target",
      "project_id": "4f9c2a7e-1b3d-4e5f-8a6b-7c8d9e0f1a2b",
      "kind": "repository",
      "address": "example/saas",
      "verified": true,
      "score": 81,
      "grade": "B",
      "last_scan_at": "2026-10-12T17:03:55.000Z",
      "hidden_issues": null
    }
  ]
}
```

## Errors

| Status | error.code | What happens |
| --- | --- | --- |
| 401 | `authentication_required` | No key in the request. Pass it in the `Authorization: Bearer rst_…` header, never in the address. |
| 401 | `invalid_api_key` | The key or OAuth token is wrong, revoked or expired. Check it is copied in full, or create a new key. |
| 402 | `api_plan_required` | The workspace is on the Free plan. The API comes with Pro, or on a 14-day trial with Solo. |
| 402 | `api_trial_ended` | Solo's 14-day trial is over. Move to Pro: your keys work again at once. |
| 403 | `scope_missing` | The OAuth token lacks the permission this route needs (shown on its page). Reconnect the agent to grant it. An API key has every permission. |
| 404 | `resource_not_found` | Nothing with this id in the key's workspace. An object of another workspace answers the same: its existence is never revealed. |
| 429 | `rate_limited` | Too many requests for this key (120 per minute). Wait `Retry-After` seconds. |
| 500 | `internal_error` | An error on our side, reported automatically. Retry later; give the `Request-Id` to support if it comes back. |
| 503 | `service_unavailable` | Rustine is unavailable for a moment. Retry with the same `Idempotency-Key`. |

https://docs.rustine.io/en/api/errors