# List images

Lists build and imported image versions, including pending and failed imports

Required permission: Project > Images > General > Read

**Path parameters:**

{object}
- `projectId`: (string) (required) ID of the project

**Query parameters:**

{object}
- `per_page`: (integer) The number of results to display per request. Maximum of 100 results per page.
- `page`: (integer) The page number to access.
- `cursor`: (string) The cursor returned from the previous page of results, used to request the next page. (min length: 24) (max length: 24)
- `nameSearch`: (string) (max length: 256)
- `tagSearch`: (string) (max length: 256)

**Response body:**

{object}
- `data`: {object}
  - `images`: [array of] {object}
     - `id`: (string) (required) (min length: 24) (max length: 24)
     - `name`: (string) (required)
     - `tag`: (string) (required)
     - `source`: (multiple options) {object}
         - `type`: (string) (required) (enum: build)
         - `buildId`: (string) (required) (min length: 24) (max length: 24)
         - `nfObjectId`: (string) (required) (min length: 24) (max length: 24)
         - `nfObjectType`: (string) (required) (enum: service, job)
         - `branch`: (string) (required) | {object}
         - `type`: (string) (required) (enum: imported)
         - `from`: (string) (required) (enum: ui, external, registry)
     - `group`: (multiple options) (string)
     - `ready`: (boolean) (required)
     - `status`: (string) (required) (enum: AWAITING_UPLOAD, IMPORTING, VALIDATING, READY, FAILURE, EXPIRED)
     - `createdAt`: (string) (required) (format: date-time)
     - `publishedAt`: (string) (format: date-time)
     - `digest`: (string) (pattern: ^sha256:[a-f0-9]{64}$)
     - `supportedArchitectures`: [array of] (string) (enum: linux/amd64, linux/arm64)
     - `imageSizeBytes`: (integer)
     - `validationError`: (string)
     - `reservationExpiresAt`: (string) (format: date-time)
     - `git`: {object}
       - `provider`: (string) (required)
       - `repo`: (string) (required)
       - `branch`: (string) (required)
       - `commit`: (string) (required)
- `pagination`: {object}
  - `hasNextPage`: (boolean) (required) Is there another page of results available?
  - `cursor`: (string) The cursor to access the next page of results.
  - `count`: (number) (required) The number of results returned by this request. (format: float)

## API reference

GET /v1/projects/{projectId}/images

GET /v1/teams/{teamId}/projects/{projectId}/images

### Example Response

200 OK: Images belonging to the project.

```json
{
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}
```

## CLI reference

$ northflank list images

Options:

- `--projectId <projectId>`: ID of the project

- `--per_page <per_page>`: The number of results to display per request. Maximum of 100 results per page.

- `--page <page>`: The page number to access.

- `--cursor <cursor>`: The cursor returned from the previous page of results, used to request the next page.

- `--nameSearch <nameSearch>`: undefined

- `--tagSearch <tagSearch>`: undefined

- `--verbose `: Verbose output

- `--quiet `: No console output

- `-o --output <format>`: Output formatting - custom-columns only applies for list commands

### Example Response

 Images belonging to the project.

```json
undefined
```

## JavaScript client reference

### Example request



With an organization token, add `parameters.teamId`. [Organization API access](/docs/v1/api/use-the-api#organization-api-access).

```javascript
await apiClient.list.images({
  parameters: {
    "projectId": "default-project"
  },
  options: {
    "per_page": 50,
    "page": 1
  }
});
```

### Example Response

 Images belonging to the project.

```json
{
  "pagination": {
    "hasNextPage": false,
    "count": 1
  },
  "rawResponse": "...",
  "request": "...",
  "error": "..."
}
```

## Python client reference

### Example request

[Set up the Python client](/docs/v1/api/use-the-python-client#usage).



With an organization token, add `team_id`. [Organization API access](/docs/v1/api/use-the-api#organization-api-access).

Python SDK 2.1.0 has no generated method for this endpoint. Use the API example for this request.

Previous: [Resume harness](/docs/v1/api/project/harnesses/resume-harness)

Next: [Prepare image upload](/docs/v1/api/project/images/prepare-image-upload)