---
title: REST API - List Users Request
slug: rm/rest-api-list-users-request
docTags: 
createdAt: 2026-06-09T13:38:46.774Z
---

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

# Description

Retrieves all users in this Blueprint instance.

# URL Structure

```bash
[Blueprint_URI]/api/v1/users
```

# Supported Methods

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

# Request URI Parameters

- `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/users?Limit=3&Offset=13
```

**Response Header**

```rust
{'content-length': '955', 'expires': '-1', 'server': 'Blueprint', 'content-range': 'users 13-15/122', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Sat, 04 May 2013 14:59:21 GMT', 'content-type': 'application/xml; charset=utf-8'}
```

**Response Body**

```xml
<?xml version="1.0" ?><Users xmlns="http://www.blueprintsys.com/blueprint/api/v1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">  <User>    <DisplayName>Steph Hubert</DisplayName>    <Firstname>Steph</Firstname>    <Groups>      <Group>        <Id>19</Id>        <Name>Dept - Product Management</Name>      </Group>      <Group>        <Id>20</Id>        <Name>Release Note Collaborators</Name>      </Group>      <Group>        <Id>34</Id>        <Name>BP Gold Group</Name>      </Group>    </Groups>    <Id>15</Id>    <Lastname>Hubert</Lastname>    <Name>blueprint\shubert</Name>  </User>  <User>    <DisplayName>Matt Dodgson</DisplayName>    <Firstname>Matthew</Firstname>    <Groups>      <Group>        <Id>7</Id>        <Name>Feature Team - Integration</Name>      </Group>      <Group>        <Id>19</Id>        <Name>Dept - Product Management</Name>      </Group>      <Group>        <Id>34</Id>        <Name>BP Gold Group</Name>      </Group>    </Groups>    <Id>16</Id>    <Lastname>Dodgson</Lastname>    <Name>blueprint\mdodgson</Name>  </User>  <User>    <DisplayName>Ari Test</DisplayName>    <Firstname>Ari</Firstname>    <Groups/>    <Id>17</Id>    <Lastname>Test</Lastname>    <Name>aritest</Name>  </User></Users>
```

## JSON Example

**Request URI**

```bash
https://production.blueprintcloud.com/api/v1/users?Limit=3&Offset=13
```

**Response Header**

```rust
{'content-length': '822', 'expires': '-1', 'server': 'Blueprint', 'content-range': 'users 13-15/122', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Sat, 04 May 2013 11:59:23 GMT', 'content-type': 'application/json; charset=utf-8'}
```

**Response Body**

```json
[  {    "DisplayName": "Steph Hubert",     "Name": "blueprint\\shubert",     "Firstname": "Steph",     "Lastname": "Hubert",     "Groups": [      {        "ProjectId": null,         "Type": "Group",         "Id": 19,         "Name": "Dept - Product Management"      },       {        "ProjectId": null,         "Type": "Group",         "Id": 20,         "Name": "Release Note Collaborators"      },       {        "ProjectId": null,         "Type": "Group",         "Id": 34,         "Name": "BP Gold Group"      }    ],     "Type": "User",     "Id": 15  },   {    "DisplayName": "Matt Dodgson",     "Name": "blueprint\\mdodgson",     "Firstname": "Matthew",     "Lastname": "Dodgson",     "Groups": [      {        "ProjectId": null,         "Type": "Group",         "Id": 7,         "Name": "Feature Team - Integration"      },       {        "ProjectId": null,         "Type": "Group",         "Id": 19,         "Name": "Dept - Product Management"      },       {        "ProjectId": null,         "Type": "Group",         "Id": 34,         "Name": "BP Gold Group"      }    ],     "Type": "User",     "Id": 16  },   {    "DisplayName": "Ari Test",     "Name": "aritest",     "Firstname": "Ari",     "Lastname": "Test",     "Groups": [],     "Type": "User",     "Id": 17  }]
```