---
title: REST API - List Projects Request
slug: rm/rest-api-list-projects-request
docTags: 
createdAt: 2026-06-09T13:38:46.723Z
---

```bash
/api/v1/projects?location={location}&offset={offset}&limit={limit}
```

# Description

Retrieves a list of projects.

Projects are only included in the response if the user (that is was authenticated to obtain the token) has permissions to view those projects.

# Supported Methods

- [HEAD](docId\:EQND3ZpTD6DwF3go3ufox)
- [GET](docId:7HM2r-Py7e84XK2mSf11b)

# Request URI Parameters

- `Location` (optional): Indicates whether to retrieve comments of the artifact. This parameter can be set to **true** or **false**. The default is **false** if not specified. The default is **true** if the parameter is included in the URI with no given value.
- `Offset`(optional): Defines the paging offset (that is, index) at which the results start. Offset the default is **0**.
- `Limit` (optional): Defines the number of items (projects, artifacts, etc) to retrieve per query. This parameter can be set to an integer. The default is **100**. The minimum value is **1** and the maximum value is **500**.

# HTTP Status Codes

- 200: OK
- 201: Successfully Created
- 206: Partial Content
- 400: Bad Request
  This error can occur for a variety of reasons:
  - At least one URI or request body parameter is invalid, such as one of the [Filter](docId\:Sv9GjVErxCZcgqdn28J7U), Traces, Offset or Limit parameters.
  - A required value has not been provided.
  - If you are submitting a [POST](docId\:Hsi_LzXS8g_RX_ydUdZKg) or [PATCH](docId\:RcjvHRLbY6de-zGKeHxuI) request and have not added the `X-HTTP-Method-Override` parameter to your request header.
- 401: Unauthorized
  - The Blueprint token is missing, invalid or expired.
- 403: Forbidden
  - The applicable permissions are needed. For example, this error can occur when:
    - An Author or Collaborate license is needed for access.
    - Comment permissions are needed on the artifact.
    - Edit permissions are needed on the change summary job.
- 404: NotFound
  - Item is not found in the project. For example, this error can occur when:
    - Artifact not found.
    - Artifact type not found.
    - Project not found.
    - ALM target not found.
    - Change summary job not found.
    - User does not have edit permissions for this artifact, project or ALM target.
- 409: Conflict
  - Reason for failure can be found in the response body. Additional information may also be found in the log.
- 411: Length Required
  - If the Content-Length header is missing in the request.
- 413: Request Entity Too Large
  - If the provided file size is larger than allowed.
- 415: Unsupported Media Type
  - If the provided media type is not of MIME Multipart Content "form-data."
- 416: Request Range Not Satisfiable
  - If `offset `points to a part of a collection that is not available.
- 500: Internal Server Error
- 501: Not Implemented

# Examples

## XML Examples

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/projects?Location=True
```

**Response Header**

```rust
{'content-length': '761', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Sat, 04 May 2013 14:58:51 GMT', 'expires': '-1', 'content-type': 'application/xml; charset=utf-8', 'server': 'Blueprint'}
```

**Response Body**

```xml
<?xml version="1.0" ?><Projects xmlns="http://www.blueprintsys.com/blueprint/api/v1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  <Project>    <Description>Documentation planning and collaboration.</Description>    <Id>13691</Id>    <Location>/Blueprint/Product Management/Steph/Documentation</Location>    <Name>Documentation</Name>  </Project>  <Project>    <Description>This project is for the creation of an online portal for BP Airways customers to make reservations and other related activities.</Description>    <Id>220870</Id>    <Location>/Blueprint/Product Management/Steph/BP Airways</Location>    <Name>BP Airways</Name>  </Project>  <Project>    <Description/>    <Id>221280</Id>    <Location>/Blueprint/Product Management/Steph/Online Banking</Location>    <Name>Online Banking</Name>  </Project></Projects>
```

## JSON Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/projects?Location=True
```

**Response Header**

```rust
{'content-length': '516', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Sat, 04 May 2013 10:47:30 GMT', 'expires': '-1', 'content-type': 'application/json; charset=utf-8', 'server': 'Blueprint'}
```

**Response Body**

```json
[  {    "Location": "/Blueprint/Product Management/Steph/Documentation",     "Description": "Documentation planning and collaboration.",     "Id": 13691,     "Name": "Documentation"  },   {    "Location": "/Blueprint/Product Management/Steph/BP Airways",     "Description": "This project is for the creation of an online portal for BP Airways customers to make reservations and other related activities.",     "Id": 220870,     "Name": "BP Airways"  },   {    "Location": "/Blueprint/Product Management/Steph/Online Banking",     "Description": "",     "Id": 221280,     "Name": "Online Banking"  }]
```