# Projects

## List Projects

`IReadOnlyList<Project> Projects.List(ProjectListParams?parameters, CancellationTokencancellationToken = default)`

**get** `/api/v1/projects`

List projects or get one by name

### Parameters

- `ProjectListParams parameters`

  - `string? organizationID`

  - `string? projectName`

### Example

```csharp
ProjectListParams parameters = new();

var projects = await client.Projects.List(parameters);

Console.WriteLine(projects);
```

#### Response

```json
[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "is_default": true,
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]
```

## Get Project

`Project Projects.Get(ProjectGetParamsparameters, CancellationTokencancellationToken = default)`

**get** `/api/v1/projects/{project_id}`

Get a project by ID.

### Parameters

- `ProjectGetParams parameters`

  - `required string projectID`

  - `string? organizationID`

### Returns

- `class Project:`

  Schema for a project.

  - `required string ID`

    Unique identifier

  - `required string Name`

  - `required string OrganizationID`

    The Organization ID the project is under.

  - `DateTimeOffset? CreatedAt`

    Creation datetime

  - `Boolean IsDefault`

    Whether this project is the default project for the user.

  - `DateTimeOffset? UpdatedAt`

    Update datetime

### Example

```csharp
ProjectGetParams parameters = new()
{
    ProjectID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var project = await client.Projects.Get(parameters);

Console.WriteLine(project);
```

#### Response

```json
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "name": "x",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "is_default": true,
  "updated_at": "2019-12-27T18:11:19.117Z"
}
```

## Domain Types

### Project

- `class Project:`

  Schema for a project.

  - `required string ID`

    Unique identifier

  - `required string Name`

  - `required string OrganizationID`

    The Organization ID the project is under.

  - `DateTimeOffset? CreatedAt`

    Creation datetime

  - `Boolean IsDefault`

    Whether this project is the default project for the user.

  - `DateTimeOffset? UpdatedAt`

    Update datetime