# Projects

> 2 endpoints: list projects, retrieve a project.

- [List Projects](#list-projects): `GET /v1/projects`
- [Retrieve a Project](#retrieve-a-project): `GET /v1/projects/{project_id}`

### List Projects

`GET /v1/projects`

Lists the Projects this key can reach, oldest first. A key limited to some Projects sees only those.

Permission: `projects:read`

#### Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Items per page, 1 to 100. (1 to 100, default 25) |
| `cursor` | string | No | The next_cursor of the previous page. (up to 512 characters) |

#### Response

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | `"list"` | Yes |  |
| `data` | array of object | Yes |  |
| `data[].object` | `"project"` | Yes |  |
| `data[].id` | string | Yes |  (up to 128 characters) |
| `data[].name` | string | Yes |  |
| `data[].status` | `active`, `archived` | Yes |  |
| `data[].timezone` | string | Yes |  |
| `data[].approval_policy` | `contributors`, `everyone` | Yes |  |
| `data[].created_at` | string | Yes | ISO 8601 date and time, UTC. |
| `has_more` | boolean | Yes |  |
| `next_cursor` | string or null | Yes |  |

```bash
curl https://api.nowscale.com/v1/projects \
  -H "Authorization: Bearer $NOWSCALE_API_KEY"
```

### Retrieve a Project

`GET /v1/projects/{project_id}`

Returns one Project this key can reach.

Permission: `projects:read`

#### Path parameters

| Name | Description |
| --- | --- |
| `project_id` | The project's id. |

#### Response

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | `"project"` | Yes |  |
| `id` | string | Yes |  (up to 128 characters) |
| `name` | string | Yes |  |
| `status` | `active`, `archived` | Yes |  |
| `timezone` | string | Yes |  |
| `approval_policy` | `contributors`, `everyone` | Yes |  |
| `created_at` | string | Yes | ISO 8601 date and time, UTC. |

```bash
curl https://api.nowscale.com/v1/projects/PROJECT_ID \
  -H "Authorization: Bearer $NOWSCALE_API_KEY"
```
